| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * WordPress API for media display. 4 * 5 * @package WordPress 6 * @subpackage Media 7 */ 8 9 // Don't load directly. 10 if ( ! defined( 'ABSPATH' ) ) { 11 die( '-1' ); 12 } 13 14 /** 15 * Retrieves additional image sizes. 16 * 17 * @since 4.7.0 18 * 19 * @global array $_wp_additional_image_sizes 20 * 21 * @return array Additional images size data. 22 */ 23 function wp_get_additional_image_sizes() { 24 global $_wp_additional_image_sizes; 25 26 if ( ! $_wp_additional_image_sizes ) { 27 $_wp_additional_image_sizes = array(); 28 } 29 30 return $_wp_additional_image_sizes; 31 } 32 33 /** 34 * Scales down the default size of an image. 35 * 36 * This is so that the image is a better fit for the editor and theme. 37 * 38 * The `$size` parameter accepts either an array or a string. The supported string 39 * values are 'thumb' or 'thumbnail' for the given thumbnail size or defaults at 40 * 128 width and 96 height in pixels. Also supported for the string value is 41 * 'medium', 'medium_large' and 'full'. The 'full' isn't actually supported, but any value other 42 * than the supported will result in the content_width size or 500 if that is 43 * not set. 44 * 45 * Finally, there is a filter named {@see 'editor_max_image_size'}, that will be 46 * called on the calculated array for width and height, respectively. 47 * 48 * @since 2.5.0 49 * 50 * @global int $content_width 51 * 52 * @param int $width Width of the image in pixels. 53 * @param int $height Height of the image in pixels. 54 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array 55 * of width and height values in pixels (in that order). Default 'medium'. 56 * @param string $context Optional. Could be 'display' (like in a theme) or 'edit' 57 * (like inserting into an editor). Default null. 58 * @return int[] { 59 * An array of width and height values. 60 * 61 * @type int $0 The maximum width in pixels. 62 * @type int $1 The maximum height in pixels. 63 * } 64 */ 65 function image_constrain_size_for_editor( $width, $height, $size = 'medium', $context = null ) { 66 global $content_width; 67 68 $_wp_additional_image_sizes = wp_get_additional_image_sizes(); 69 70 if ( ! $context ) { 71 $context = is_admin() ? 'edit' : 'display'; 72 } 73 74 if ( is_array( $size ) ) { 75 $max_width = $size[0]; 76 $max_height = $size[1]; 77 } elseif ( 'thumb' === $size || 'thumbnail' === $size ) { 78 $max_width = (int) get_option( 'thumbnail_size_w' ); 79 $max_height = (int) get_option( 'thumbnail_size_h' ); 80 // Last chance thumbnail size defaults. 81 if ( ! $max_width && ! $max_height ) { 82 $max_width = 128; 83 $max_height = 96; 84 } 85 } elseif ( 'medium' === $size ) { 86 $max_width = (int) get_option( 'medium_size_w' ); 87 $max_height = (int) get_option( 'medium_size_h' ); 88 89 } elseif ( 'medium_large' === $size ) { 90 $max_width = (int) get_option( 'medium_large_size_w' ); 91 $max_height = (int) get_option( 'medium_large_size_h' ); 92 93 if ( (int) $content_width > 0 ) { 94 $max_width = min( (int) $content_width, $max_width ); 95 } 96 } elseif ( 'large' === $size ) { 97 /* 98 * We're inserting a large size image into the editor. If it's a really 99 * big image we'll scale it down to fit reasonably within the editor 100 * itself, and within the theme's content width if it's known. The user 101 * can resize it in the editor if they wish. 102 */ 103 $max_width = (int) get_option( 'large_size_w' ); 104 $max_height = (int) get_option( 'large_size_h' ); 105 106 if ( (int) $content_width > 0 ) { 107 $max_width = min( (int) $content_width, $max_width ); 108 } 109 } elseif ( ! empty( $_wp_additional_image_sizes ) && in_array( $size, array_keys( $_wp_additional_image_sizes ), true ) ) { 110 $max_width = (int) $_wp_additional_image_sizes[ $size ]['width']; 111 $max_height = (int) $_wp_additional_image_sizes[ $size ]['height']; 112 // Only in admin. Assume that theme authors know what they're doing. 113 if ( (int) $content_width > 0 && 'edit' === $context ) { 114 $max_width = min( (int) $content_width, $max_width ); 115 } 116 } else { // $size === 'full' has no constraint. 117 $max_width = $width; 118 $max_height = $height; 119 } 120 121 /** 122 * Filters the maximum image size dimensions for the editor. 123 * 124 * @since 2.5.0 125 * 126 * @param int[] $max_image_size { 127 * An array of width and height values. 128 * 129 * @type int $0 The maximum width in pixels. 130 * @type int $1 The maximum height in pixels. 131 * } 132 * @param string|int[] $size Requested image size. Can be any registered image size name, or 133 * an array of width and height values in pixels (in that order). 134 * @param string $context The context the image is being resized for. 135 * Possible values are 'display' (like in a theme) 136 * or 'edit' (like inserting into an editor). 137 */ 138 list( $max_width, $max_height ) = apply_filters( 'editor_max_image_size', array( $max_width, $max_height ), $size, $context ); 139 140 return wp_constrain_dimensions( $width, $height, $max_width, $max_height ); 141 } 142 143 /** 144 * Retrieves width and height attributes using given width and height values. 145 * 146 * Both attributes are required in the sense that both parameters must have a 147 * value, but are optional in that if you set them to false or null, then they 148 * will not be added to the returned string. 149 * 150 * You can set the value using a string, but it will only take numeric values. 151 * If you wish to put 'px' after the numbers, then it will be stripped out of 152 * the return. 153 * 154 * @since 2.5.0 155 * 156 * @param int|string $width Image width in pixels. 157 * @param int|string $height Image height in pixels. 158 * @return string HTML attributes for width and, or height. 159 */ 160 function image_hwstring( $width, $height ) { 161 $out = ''; 162 if ( $width ) { 163 $out .= 'width="' . (int) $width . '" '; 164 } 165 if ( $height ) { 166 $out .= 'height="' . (int) $height . '" '; 167 } 168 return $out; 169 } 170 171 /** 172 * Scales an image to fit a particular size (such as 'thumb' or 'medium'). 173 * 174 * The URL might be the original image, or it might be a resized version. This 175 * function won't create a new resized copy, it will just return an already 176 * resized one if it exists. 177 * 178 * A plugin may use the {@see 'image_downsize'} filter to hook into and offer image 179 * resizing services for images. The hook must return an array with the same 180 * elements that are normally returned from the function. 181 * 182 * @since 2.5.0 183 * 184 * @param int $id Attachment ID for image. 185 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array 186 * of width and height values in pixels (in that order). Default 'medium'. 187 * @return array|false { 188 * Array of image data, or boolean false if no image is available. 189 * 190 * @type string $0 Image source URL. 191 * @type int $1 Image width in pixels. 192 * @type int $2 Image height in pixels. 193 * @type bool $3 Whether the image is a resized image. 194 * } 195 */ 196 function image_downsize( $id, $size = 'medium' ) { 197 $is_image = wp_attachment_is_image( $id ); 198 199 /** 200 * Filters whether to preempt the output of image_downsize(). 201 * 202 * Returning a truthy value from the filter will effectively short-circuit 203 * down-sizing the image, returning that value instead. 204 * 205 * @since 2.5.0 206 * 207 * @param bool|array $downsize Whether to short-circuit the image downsize. 208 * @param int $id Attachment ID for image. 209 * @param string|int[] $size Requested image size. Can be any registered image size name, or 210 * an array of width and height values in pixels (in that order). 211 */ 212 $out = apply_filters( 'image_downsize', false, $id, $size ); 213 214 if ( $out ) { 215 return $out; 216 } 217 218 $img_url = wp_get_attachment_url( $id ); 219 $meta = wp_get_attachment_metadata( $id ); 220 $width = 0; 221 $height = 0; 222 $is_intermediate = false; 223 $img_url_basename = wp_basename( $img_url ); 224 225 /* 226 * If the file isn't an image, attempt to replace its URL with a rendered image from its meta. 227 * Otherwise, a non-image type could be returned. 228 */ 229 if ( ! $is_image ) { 230 if ( ! empty( $meta['sizes']['full'] ) ) { 231 $img_url = str_replace( $img_url_basename, $meta['sizes']['full']['file'], $img_url ); 232 $img_url_basename = $meta['sizes']['full']['file']; 233 $width = $meta['sizes']['full']['width']; 234 $height = $meta['sizes']['full']['height']; 235 } else { 236 return false; 237 } 238 } 239 240 // Try for a new style intermediate size. 241 $intermediate = image_get_intermediate_size( $id, $size ); 242 243 if ( $intermediate ) { 244 $img_url = str_replace( $img_url_basename, $intermediate['file'], $img_url ); 245 $width = $intermediate['width']; 246 $height = $intermediate['height']; 247 $is_intermediate = true; 248 } elseif ( 'thumbnail' === $size && ! empty( $meta['thumb'] ) && is_string( $meta['thumb'] ) ) { 249 // Fall back to the old thumbnail. 250 $imagefile = get_attached_file( $id ); 251 $thumbfile = str_replace( wp_basename( $imagefile ), wp_basename( $meta['thumb'] ), $imagefile ); 252 253 if ( file_exists( $thumbfile ) ) { 254 $info = wp_getimagesize( $thumbfile ); 255 256 if ( $info ) { 257 $img_url = str_replace( $img_url_basename, wp_basename( $thumbfile ), $img_url ); 258 $width = $info[0]; 259 $height = $info[1]; 260 $is_intermediate = true; 261 } 262 } 263 } 264 265 if ( ! $width && ! $height && isset( $meta['width'], $meta['height'] ) ) { 266 // Any other type: use the real image. 267 $width = $meta['width']; 268 $height = $meta['height']; 269 } 270 271 if ( $img_url ) { 272 // We have the actual image size, but might need to further constrain it if content_width is narrower. 273 list( $width, $height ) = image_constrain_size_for_editor( $width, $height, $size ); 274 275 return array( $img_url, $width, $height, $is_intermediate ); 276 } 277 278 return false; 279 } 280 281 /** 282 * Registers a new image size. 283 * 284 * @since 2.9.0 285 * 286 * @global array $_wp_additional_image_sizes Associative array of additional image sizes. 287 * 288 * @param string $name Image size identifier. 289 * @param int $width Optional. Image width in pixels. Default 0. 290 * @param int $height Optional. Image height in pixels. Default 0. 291 * @param bool|array $crop { 292 * Optional. Image cropping behavior. If false, the image will be scaled (default). 293 * If true, image will be cropped to the specified dimensions using center positions. 294 * If an array, the image will be cropped using the array to specify the crop location: 295 * 296 * @type string $0 The x crop position. Accepts 'left', 'center', or 'right'. 297 * @type string $1 The y crop position. Accepts 'top', 'center', or 'bottom'. 298 * } 299 */ 300 function add_image_size( $name, $width = 0, $height = 0, $crop = false ) { 301 global $_wp_additional_image_sizes; 302 303 $_wp_additional_image_sizes[ $name ] = array( 304 'width' => absint( $width ), 305 'height' => absint( $height ), 306 'crop' => $crop, 307 ); 308 } 309 310 /** 311 * Checks if an image size exists. 312 * 313 * @since 3.9.0 314 * 315 * @param string $name The image size to check. 316 * @return bool True if the image size exists, false if not. 317 */ 318 function has_image_size( $name ) { 319 $sizes = wp_get_additional_image_sizes(); 320 return isset( $sizes[ $name ] ); 321 } 322 323 /** 324 * Removes a new image size. 325 * 326 * @since 3.9.0 327 * 328 * @global array $_wp_additional_image_sizes 329 * 330 * @param string $name The image size to remove. 331 * @return bool True if the image size was successfully removed, false on failure. 332 */ 333 function remove_image_size( $name ) { 334 global $_wp_additional_image_sizes; 335 336 if ( isset( $_wp_additional_image_sizes[ $name ] ) ) { 337 unset( $_wp_additional_image_sizes[ $name ] ); 338 return true; 339 } 340 341 return false; 342 } 343 344 /** 345 * Registers an image size for the post thumbnail. 346 * 347 * @since 2.9.0 348 * 349 * @see add_image_size() for details on cropping behavior. 350 * 351 * @param int $width Image width in pixels. 352 * @param int $height Image height in pixels. 353 * @param bool|array $crop { 354 * Optional. Image cropping behavior. If false, the image will be scaled (default). 355 * If true, image will be cropped to the specified dimensions using center positions. 356 * If an array, the image will be cropped using the array to specify the crop location: 357 * 358 * @type string $0 The x crop position. Accepts 'left', 'center', or 'right'. 359 * @type string $1 The y crop position. Accepts 'top', 'center', or 'bottom'. 360 * } 361 */ 362 function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) { 363 add_image_size( 'post-thumbnail', $width, $height, $crop ); 364 } 365 366 /** 367 * Gets an img tag for an image attachment, scaling it down if requested. 368 * 369 * The {@see 'get_image_tag_class'} filter allows for changing the class name for the 370 * image without having to use regular expressions on the HTML content. The 371 * parameters are: what WordPress will use for the class, the Attachment ID, 372 * image align value, and the size the image should be. 373 * 374 * The second filter, {@see 'get_image_tag'}, has the HTML content, which can then be 375 * further manipulated by a plugin to change all attribute values and even HTML 376 * content. 377 * 378 * @since 2.5.0 379 * 380 * @param int $id Attachment ID. 381 * @param string $alt Image description for the alt attribute. 382 * @param string $title Image description for the title attribute. 383 * @param string $align Part of the class name for aligning the image. 384 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of 385 * width and height values in pixels (in that order). Default 'medium'. 386 * @return string HTML IMG element for given image attachment. 387 */ 388 function get_image_tag( $id, $alt, $title, $align, $size = 'medium' ) { 389 390 list( $img_src, $width, $height ) = image_downsize( $id, $size ); 391 $hwstring = image_hwstring( $width, $height ); 392 393 $title = $title ? 'title="' . esc_attr( $title ) . '" ' : ''; 394 395 $size_class = is_array( $size ) ? implode( 'x', $size ) : $size; 396 $class = 'align' . esc_attr( $align ) . ' size-' . esc_attr( $size_class ) . ' wp-image-' . $id; 397 398 /** 399 * Filters the value of the attachment's image tag class attribute. 400 * 401 * @since 2.6.0 402 * 403 * @param string $class CSS class name or space-separated list of classes. 404 * @param int $id Attachment ID. 405 * @param string $align Part of the class name for aligning the image. 406 * @param string|int[] $size Requested image size. Can be any registered image size name, or 407 * an array of width and height values in pixels (in that order). 408 */ 409 $class = apply_filters( 'get_image_tag_class', $class, $id, $align, $size ); 410 411 $html = '<img src="' . esc_url( $img_src ) . '" alt="' . esc_attr( $alt ) . '" ' . $title . $hwstring . 'class="' . $class . '" />'; 412 413 /** 414 * Filters the HTML content for the image tag. 415 * 416 * @since 2.6.0 417 * 418 * @param string $html HTML content for the image. 419 * @param int $id Attachment ID. 420 * @param string $alt Image description for the alt attribute. 421 * @param string $title Image description for the title attribute. 422 * @param string $align Part of the class name for aligning the image. 423 * @param string|int[] $size Requested image size. Can be any registered image size name, or 424 * an array of width and height values in pixels (in that order). 425 */ 426 return apply_filters( 'get_image_tag', $html, $id, $alt, $title, $align, $size ); 427 } 428 429 /** 430 * Calculates the new dimensions for a down-sampled image. 431 * 432 * If either width or height are empty, no constraint is applied on 433 * that dimension. 434 * 435 * @since 2.5.0 436 * 437 * @param int $current_width Current width of the image. 438 * @param int $current_height Current height of the image. 439 * @param int $max_width Optional. Max width in pixels to constrain to. Default 0. 440 * @param int $max_height Optional. Max height in pixels to constrain to. Default 0. 441 * @return int[] { 442 * An array of width and height values. 443 * 444 * @type int $0 The width in pixels. 445 * @type int $1 The height in pixels. 446 * } 447 */ 448 function wp_constrain_dimensions( $current_width, $current_height, $max_width = 0, $max_height = 0 ) { 449 if ( ! $max_width && ! $max_height ) { 450 return array( $current_width, $current_height ); 451 } 452 453 $width_ratio = 1.0; 454 $height_ratio = 1.0; 455 $did_width = false; 456 $did_height = false; 457 458 if ( $max_width > 0 && $current_width > 0 && $current_width > $max_width ) { 459 $width_ratio = $max_width / $current_width; 460 $did_width = true; 461 } 462 463 if ( $max_height > 0 && $current_height > 0 && $current_height > $max_height ) { 464 $height_ratio = $max_height / $current_height; 465 $did_height = true; 466 } 467 468 // Calculate the larger/smaller ratios. 469 $smaller_ratio = min( $width_ratio, $height_ratio ); 470 $larger_ratio = max( $width_ratio, $height_ratio ); 471 472 if ( (int) round( $current_width * $larger_ratio ) > $max_width || (int) round( $current_height * $larger_ratio ) > $max_height ) { 473 // The larger ratio is too big. It would result in an overflow. 474 $ratio = $smaller_ratio; 475 } else { 476 // The larger ratio fits, and is likely to be a more "snug" fit. 477 $ratio = $larger_ratio; 478 } 479 480 // Very small dimensions may result in 0, 1 should be the minimum. 481 $w = max( 1, (int) round( $current_width * $ratio ) ); 482 $h = max( 1, (int) round( $current_height * $ratio ) ); 483 484 /* 485 * Sometimes, due to rounding, we'll end up with a result like this: 486 * 465x700 in a 177x177 box is 117x176... a pixel short. 487 * We also have issues with recursive calls resulting in an ever-changing result. 488 * Constraining to the result of a constraint should yield the original result. 489 * Thus we look for dimensions that are one pixel shy of the max value and bump them up. 490 */ 491 492 // Note: $did_width means it is possible $smaller_ratio == $width_ratio. 493 if ( $did_width && $w === $max_width - 1 ) { 494 $w = $max_width; // Round it up. 495 } 496 497 // Note: $did_height means it is possible $smaller_ratio == $height_ratio. 498 if ( $did_height && $h === $max_height - 1 ) { 499 $h = $max_height; // Round it up. 500 } 501 502 /** 503 * Filters dimensions to constrain down-sampled images to. 504 * 505 * @since 4.1.0 506 * 507 * @param int[] $dimensions { 508 * An array of width and height values. 509 * 510 * @type int $0 The width in pixels. 511 * @type int $1 The height in pixels. 512 * } 513 * @param int $current_width The current width of the image. 514 * @param int $current_height The current height of the image. 515 * @param int $max_width The maximum width permitted. 516 * @param int $max_height The maximum height permitted. 517 */ 518 return apply_filters( 'wp_constrain_dimensions', array( $w, $h ), $current_width, $current_height, $max_width, $max_height ); 519 } 520 521 /** 522 * Retrieves calculated resize dimensions for use in WP_Image_Editor. 523 * 524 * Calculates dimensions and coordinates for a resized image that fits 525 * within a specified width and height. 526 * 527 * @since 2.5.0 528 * 529 * @param int $orig_w Original width in pixels. 530 * @param int $orig_h Original height in pixels. 531 * @param int $dest_w New width in pixels. 532 * @param int $dest_h New height in pixels. 533 * @param bool|array $crop { 534 * Optional. Image cropping behavior. If false, the image will be scaled (default). 535 * If true, image will be cropped to the specified dimensions using center positions. 536 * If an array, the image will be cropped using the array to specify the crop location: 537 * 538 * @type string $0 The x crop position. Accepts 'left', 'center', or 'right'. 539 * @type string $1 The y crop position. Accepts 'top', 'center', or 'bottom'. 540 * } 541 * @return array|false Returned array matches parameters for `imagecopyresampled()`. False on failure. 542 */ 543 function image_resize_dimensions( $orig_w, $orig_h, $dest_w, $dest_h, $crop = false ) { 544 545 if ( $orig_w <= 0 || $orig_h <= 0 ) { 546 return false; 547 } 548 // At least one of $dest_w or $dest_h must be specific. 549 if ( $dest_w <= 0 && $dest_h <= 0 ) { 550 return false; 551 } 552 553 /** 554 * Filters whether to preempt calculating the image resize dimensions. 555 * 556 * Returning a non-null value from the filter will effectively short-circuit 557 * image_resize_dimensions(), returning that value instead. 558 * 559 * @since 3.4.0 560 * 561 * @param null|mixed $null Whether to preempt output of the resize dimensions. 562 * @param int $orig_w Original width in pixels. 563 * @param int $orig_h Original height in pixels. 564 * @param int $dest_w New width in pixels. 565 * @param int $dest_h New height in pixels. 566 * @param bool|array $crop Whether to crop image to specified width and height or resize. 567 * An array can specify positioning of the crop area. Default false. 568 */ 569 $output = apply_filters( 'image_resize_dimensions', null, $orig_w, $orig_h, $dest_w, $dest_h, $crop ); 570 571 if ( null !== $output ) { 572 return $output; 573 } 574 575 // Stop if the destination size is larger than the original image dimensions. 576 if ( empty( $dest_h ) ) { 577 if ( $orig_w < $dest_w ) { 578 return false; 579 } 580 } elseif ( empty( $dest_w ) ) { 581 if ( $orig_h < $dest_h ) { 582 return false; 583 } 584 } else { 585 if ( $orig_w < $dest_w && $orig_h < $dest_h ) { 586 return false; 587 } 588 } 589 590 if ( $crop ) { 591 /* 592 * Crop the largest possible portion of the original image that we can size to $dest_w x $dest_h. 593 * Note that the requested crop dimensions are used as a maximum bounding box for the original image. 594 * If the original image's width or height is less than the requested width or height 595 * only the greater one will be cropped. 596 * For example when the original image is 600x300, and the requested crop dimensions are 400x400, 597 * the resulting image will be 400x300. 598 */ 599 $aspect_ratio = $orig_w / $orig_h; 600 $new_w = min( $dest_w, $orig_w ); 601 $new_h = min( $dest_h, $orig_h ); 602 603 if ( ! $new_w ) { 604 $new_w = (int) round( $new_h * $aspect_ratio ); 605 } 606 607 if ( ! $new_h ) { 608 $new_h = (int) round( $new_w / $aspect_ratio ); 609 } 610 611 $size_ratio = max( $new_w / $orig_w, $new_h / $orig_h ); 612 613 $crop_w = round( $new_w / $size_ratio ); 614 $crop_h = round( $new_h / $size_ratio ); 615 616 if ( ! is_array( $crop ) || count( $crop ) !== 2 ) { 617 $crop = array( 'center', 'center' ); 618 } 619 620 list( $x, $y ) = $crop; 621 622 if ( 'left' === $x ) { 623 $s_x = 0; 624 } elseif ( 'right' === $x ) { 625 $s_x = $orig_w - $crop_w; 626 } else { 627 $s_x = floor( ( $orig_w - $crop_w ) / 2 ); 628 } 629 630 if ( 'top' === $y ) { 631 $s_y = 0; 632 } elseif ( 'bottom' === $y ) { 633 $s_y = $orig_h - $crop_h; 634 } else { 635 $s_y = floor( ( $orig_h - $crop_h ) / 2 ); 636 } 637 } else { 638 // Resize using $dest_w x $dest_h as a maximum bounding box. 639 $crop_w = $orig_w; 640 $crop_h = $orig_h; 641 642 $s_x = 0; 643 $s_y = 0; 644 645 list( $new_w, $new_h ) = wp_constrain_dimensions( $orig_w, $orig_h, $dest_w, $dest_h ); 646 } 647 648 if ( wp_fuzzy_number_match( $new_w, $orig_w ) && wp_fuzzy_number_match( $new_h, $orig_h ) ) { 649 // The new size has virtually the same dimensions as the original image. 650 651 /** 652 * Filters whether to proceed with making an image sub-size with identical dimensions 653 * with the original/source image. Differences of 1px may be due to rounding and are ignored. 654 * 655 * @since 5.3.0 656 * 657 * @param bool $proceed The filtered value. 658 * @param int $orig_w Original image width. 659 * @param int $orig_h Original image height. 660 */ 661 $proceed = (bool) apply_filters( 'wp_image_resize_identical_dimensions', false, $orig_w, $orig_h ); 662 663 if ( ! $proceed ) { 664 return false; 665 } 666 } 667 668 /* 669 * The return array matches the parameters to imagecopyresampled(). 670 * int dst_x, int dst_y, int src_x, int src_y, int dst_w, int dst_h, int src_w, int src_h 671 */ 672 return array( 0, 0, (int) $s_x, (int) $s_y, (int) $new_w, (int) $new_h, (int) $crop_w, (int) $crop_h ); 673 } 674 675 /** 676 * Resizes an image to make a thumbnail or intermediate size. 677 * 678 * The returned array has the file size, the image width, and image height. The 679 * {@see 'image_make_intermediate_size'} filter can be used to hook in and change the 680 * values of the returned array. The only parameter is the resized file path. 681 * 682 * @since 2.5.0 683 * 684 * @param string $file File path. 685 * @param int $width Image width. 686 * @param int $height Image height. 687 * @param bool|array $crop { 688 * Optional. Image cropping behavior. If false, the image will be scaled (default). 689 * If true, image will be cropped to the specified dimensions using center positions. 690 * If an array, the image will be cropped using the array to specify the crop location: 691 * 692 * @type string $0 The x crop position. Accepts 'left', 'center', or 'right'. 693 * @type string $1 The y crop position. Accepts 'top', 'center', or 'bottom'. 694 * } 695 * @return array|false Metadata array on success. False if no image was created. 696 */ 697 function image_make_intermediate_size( $file, $width, $height, $crop = false ) { 698 if ( $width || $height ) { 699 $editor = wp_get_image_editor( $file ); 700 701 if ( is_wp_error( $editor ) || is_wp_error( $editor->resize( $width, $height, $crop ) ) ) { 702 return false; 703 } 704 705 $resized_file = $editor->save(); 706 707 if ( ! is_wp_error( $resized_file ) && $resized_file ) { 708 unset( $resized_file['path'] ); 709 return $resized_file; 710 } 711 } 712 return false; 713 } 714 715 /** 716 * Helper function to test if aspect ratios for two images match. 717 * 718 * @since 4.6.0 719 * 720 * @param int $source_width Width of the first image in pixels. 721 * @param int $source_height Height of the first image in pixels. 722 * @param int $target_width Width of the second image in pixels. 723 * @param int $target_height Height of the second image in pixels. 724 * @return bool True if aspect ratios match within 1px. False if not. 725 */ 726 function wp_image_matches_ratio( $source_width, $source_height, $target_width, $target_height ) { 727 /* 728 * To test for varying crops, we constrain the dimensions of the larger image 729 * to the dimensions of the smaller image and see if they match. 730 */ 731 if ( $source_width > $target_width ) { 732 $constrained_size = wp_constrain_dimensions( $source_width, $source_height, $target_width ); 733 $expected_size = array( $target_width, $target_height ); 734 } else { 735 $constrained_size = wp_constrain_dimensions( $target_width, $target_height, $source_width ); 736 $expected_size = array( $source_width, $source_height ); 737 } 738 739 // If the image dimensions are within 1px of the expected size, we consider it a match. 740 $matched = ( wp_fuzzy_number_match( $constrained_size[0], $expected_size[0] ) && wp_fuzzy_number_match( $constrained_size[1], $expected_size[1] ) ); 741 742 return $matched; 743 } 744 745 /** 746 * Retrieves the image's intermediate size (resized) path, width, and height. 747 * 748 * The $size parameter can be an array with the width and height respectively. 749 * If the size matches the 'sizes' metadata array for width and height, then it 750 * will be used. If there is no direct match, then the nearest image size larger 751 * than the specified size will be used. If nothing is found, then the function 752 * will break out and return false. 753 * 754 * The metadata 'sizes' is used for compatible sizes that can be used for the 755 * parameter $size value. 756 * 757 * The url path will be given, when the $size parameter is a string. 758 * 759 * If you are passing an array for the $size, you should consider using 760 * add_image_size() so that a cropped version is generated. It's much more 761 * efficient than having to find the closest-sized image and then having the 762 * browser scale down the image. 763 * 764 * @since 2.5.0 765 * 766 * @param int $post_id Attachment ID. 767 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array 768 * of width and height values in pixels (in that order). Default 'thumbnail'. 769 * @return array|false { 770 * Array of file relative path, width, and height on success. Additionally includes absolute 771 * path and URL if registered size is passed to `$size` parameter. False on failure. 772 * 773 * @type string $file Filename of image. 774 * @type int $width Width of image in pixels. 775 * @type int $height Height of image in pixels. 776 * @type string $path Path of image relative to uploads directory. 777 * @type string $url URL of image. 778 * } 779 */ 780 function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) { 781 $imagedata = wp_get_attachment_metadata( $post_id ); 782 783 if ( ! $size || ! is_array( $imagedata ) || empty( $imagedata['sizes'] ) ) { 784 return false; 785 } 786 787 $data = array(); 788 789 // Find the best match when '$size' is an array. 790 if ( is_array( $size ) ) { 791 $candidates = array(); 792 793 if ( ! isset( $imagedata['file'] ) && isset( $imagedata['sizes']['full'] ) ) { 794 $imagedata['height'] = $imagedata['sizes']['full']['height']; 795 $imagedata['width'] = $imagedata['sizes']['full']['width']; 796 } 797 798 foreach ( $imagedata['sizes'] as $_size => $data ) { 799 // If there's an exact match to an existing image size, short circuit. 800 if ( (int) $data['width'] === (int) $size[0] && (int) $data['height'] === (int) $size[1] ) { 801 $candidates[ $data['width'] * $data['height'] ] = $data; 802 break; 803 } 804 805 // If it's not an exact match, consider larger sizes with the same aspect ratio. 806 if ( $data['width'] >= $size[0] && $data['height'] >= $size[1] ) { 807 // If '0' is passed to either size, we test ratios against the original file. 808 if ( 0 === $size[0] || 0 === $size[1] ) { 809 $same_ratio = wp_image_matches_ratio( $data['width'], $data['height'], $imagedata['width'], $imagedata['height'] ); 810 } else { 811 $same_ratio = wp_image_matches_ratio( $data['width'], $data['height'], $size[0], $size[1] ); 812 } 813 814 if ( $same_ratio ) { 815 $candidates[ $data['width'] * $data['height'] ] = $data; 816 } 817 } 818 } 819 820 if ( ! empty( $candidates ) ) { 821 // Sort the array by size if we have more than one candidate. 822 if ( 1 < count( $candidates ) ) { 823 ksort( $candidates ); 824 } 825 826 $data = array_shift( $candidates ); 827 /* 828 * When the size requested is smaller than the thumbnail dimensions, we 829 * fall back to the thumbnail size to maintain backward compatibility with 830 * pre 4.6 versions of WordPress. 831 */ 832 } elseif ( ! empty( $imagedata['sizes']['thumbnail'] ) && $imagedata['sizes']['thumbnail']['width'] >= $size[0] && $imagedata['sizes']['thumbnail']['width'] >= $size[1] ) { 833 $data = $imagedata['sizes']['thumbnail']; 834 } else { 835 return false; 836 } 837 838 // Constrain the width and height attributes to the requested values. 839 list( $data['width'], $data['height'] ) = image_constrain_size_for_editor( $data['width'], $data['height'], $size ); 840 841 } elseif ( ! empty( $imagedata['sizes'][ $size ] ) ) { 842 $data = $imagedata['sizes'][ $size ]; 843 } 844 845 // If we still don't have a match at this point, return false. 846 if ( empty( $data ) ) { 847 return false; 848 } 849 850 // Include the full filesystem path of the intermediate file. 851 if ( empty( $data['path'] ) && ! empty( $data['file'] ) && ! empty( $imagedata['file'] ) ) { 852 $file_url = wp_get_attachment_url( $post_id ); 853 $data['path'] = path_join( dirname( $imagedata['file'] ), $data['file'] ); 854 $data['url'] = path_join( dirname( $file_url ), $data['file'] ); 855 } 856 857 /** 858 * Filters the output of image_get_intermediate_size() 859 * 860 * @since 4.4.0 861 * 862 * @see image_get_intermediate_size() 863 * 864 * @param array $data Array of file relative path, width, and height on success. May also include 865 * file absolute path and URL. 866 * @param int $post_id The ID of the image attachment. 867 * @param string|int[] $size Requested image size. Can be any registered image size name, or 868 * an array of width and height values in pixels (in that order). 869 */ 870 return apply_filters( 'image_get_intermediate_size', $data, $post_id, $size ); 871 } 872 873 /** 874 * Gets the available intermediate image size names. 875 * 876 * @since 3.0.0 877 * 878 * @return string[] An array of image size names. 879 */ 880 function get_intermediate_image_sizes() { 881 $default_sizes = array( 'thumbnail', 'medium', 'medium_large', 'large' ); 882 $additional_sizes = wp_get_additional_image_sizes(); 883 884 if ( ! empty( $additional_sizes ) ) { 885 $default_sizes = array_merge( $default_sizes, array_keys( $additional_sizes ) ); 886 } 887 888 /** 889 * Filters the list of intermediate image sizes. 890 * 891 * @since 2.5.0 892 * 893 * @param string[] $default_sizes An array of intermediate image size names. Defaults 894 * are 'thumbnail', 'medium', 'medium_large', 'large'. 895 */ 896 return apply_filters( 'intermediate_image_sizes', $default_sizes ); 897 } 898 899 /** 900 * Returns a normalized list of all currently registered image sub-sizes. 901 * 902 * @since 5.3.0 903 * @uses wp_get_additional_image_sizes() 904 * @uses get_intermediate_image_sizes() 905 * 906 * @return array[] Associative array of arrays of image sub-size information, 907 * keyed by image size name. 908 */ 909 function wp_get_registered_image_subsizes() { 910 $additional_sizes = wp_get_additional_image_sizes(); 911 $all_sizes = array(); 912 913 foreach ( get_intermediate_image_sizes() as $size_name ) { 914 $size_data = array( 915 'width' => 0, 916 'height' => 0, 917 'crop' => false, 918 ); 919 920 if ( isset( $additional_sizes[ $size_name ]['width'] ) ) { 921 // For sizes added by plugins and themes. 922 $size_data['width'] = (int) $additional_sizes[ $size_name ]['width']; 923 } else { 924 // For default sizes set in options. 925 $size_data['width'] = (int) get_option( "{$size_name}_size_w" ); 926 } 927 928 if ( isset( $additional_sizes[ $size_name ]['height'] ) ) { 929 $size_data['height'] = (int) $additional_sizes[ $size_name ]['height']; 930 } else { 931 $size_data['height'] = (int) get_option( "{$size_name}_size_h" ); 932 } 933 934 if ( empty( $size_data['width'] ) && empty( $size_data['height'] ) ) { 935 // This size isn't set. 936 continue; 937 } 938 939 if ( isset( $additional_sizes[ $size_name ]['crop'] ) ) { 940 $size_data['crop'] = $additional_sizes[ $size_name ]['crop']; 941 } else { 942 $size_data['crop'] = get_option( "{$size_name}_crop" ); 943 } 944 945 if ( ! is_array( $size_data['crop'] ) || empty( $size_data['crop'] ) ) { 946 $size_data['crop'] = (bool) $size_data['crop']; 947 } 948 949 $all_sizes[ $size_name ] = $size_data; 950 } 951 952 return $all_sizes; 953 } 954 955 /** 956 * Retrieves an image to represent an attachment. 957 * 958 * @since 2.5.0 959 * 960 * @param int $attachment_id Image attachment ID. 961 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of 962 * width and height values in pixels (in that order). Default 'thumbnail'. 963 * @param bool $icon Optional. Whether the image should fall back to a mime type icon. Default false. 964 * @return array|false { 965 * Array of image data, or boolean false if no image is available. 966 * 967 * @type string $0 Image source URL. 968 * @type int $1 Image width in pixels. 969 * @type int $2 Image height in pixels. 970 * @type bool $3 Whether the image is a resized image. 971 * } 972 */ 973 function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon = false ) { 974 // Get a thumbnail or intermediate image if there is one. 975 $image = image_downsize( $attachment_id, $size ); 976 if ( ! $image ) { 977 $src = false; 978 979 if ( $icon ) { 980 $src = wp_mime_type_icon( $attachment_id, '.svg' ); 981 982 if ( $src ) { 983 /** This filter is documented in wp-includes/post.php */ 984 $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' ); 985 986 $src_file = $icon_dir . '/' . wp_basename( $src ); 987 988 list( $width, $height ) = wp_getimagesize( $src_file ); 989 990 $ext = strtolower( substr( $src_file, -4 ) ); 991 992 if ( '.svg' === $ext ) { 993 // SVG does not have true dimensions, so this assigns width and height directly. 994 $width = 48; 995 $height = 64; 996 } else { 997 list( $width, $height ) = wp_getimagesize( $src_file ); 998 } 999 } 1000 } 1001 1002 if ( $src && $width && $height ) { 1003 $image = array( $src, $width, $height, false ); 1004 } 1005 } 1006 /** 1007 * Filters the attachment image source result. 1008 * 1009 * @since 4.3.0 1010 * 1011 * @param array|false $image { 1012 * Array of image data, or boolean false if no image is available. 1013 * 1014 * @type string $0 Image source URL. 1015 * @type int $1 Image width in pixels. 1016 * @type int $2 Image height in pixels. 1017 * @type bool $3 Whether the image is a resized image. 1018 * } 1019 * @param int $attachment_id Image attachment ID. 1020 * @param string|int[] $size Requested image size. Can be any registered image size name, or 1021 * an array of width and height values in pixels (in that order). 1022 * @param bool $icon Whether the image should be treated as an icon. 1023 */ 1024 return apply_filters( 'wp_get_attachment_image_src', $image, $attachment_id, $size, $icon ); 1025 } 1026 1027 /** 1028 * Gets an HTML img element representing an image attachment. 1029 * 1030 * While `$size` will accept an array, it is better to register a size with 1031 * add_image_size() so that a cropped version is generated. It's much more 1032 * efficient than having to find the closest-sized image and then having the 1033 * browser scale down the image. 1034 * 1035 * @since 2.5.0 1036 * @since 4.4.0 The `$srcset` and `$sizes` attributes were added. 1037 * @since 5.5.0 The `$loading` attribute was added. 1038 * @since 6.1.0 The `$decoding` attribute was added. 1039 * 1040 * @param int $attachment_id Image attachment ID. 1041 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array 1042 * of width and height values in pixels (in that order). Default 'thumbnail'. 1043 * @param bool $icon Optional. Whether the image should be treated as an icon. Default false. 1044 * @param string|array $attr { 1045 * Optional. Attributes for the image markup. 1046 * 1047 * @type string $src Image attachment URL. 1048 * @type string $class CSS class name or space-separated list of classes. 1049 * Default `attachment-$size_class size-$size_class`, 1050 * where `$size_class` is the image size being requested. 1051 * @type string $alt Image description for the alt attribute. 1052 * @type string $srcset The 'srcset' attribute value. 1053 * @type string $sizes The 'sizes' attribute value. 1054 * @type string|false $loading The 'loading' attribute value. Passing a value of false 1055 * will result in the attribute being omitted for the image. 1056 * Default determined by {@see wp_get_loading_optimization_attributes()}. 1057 * @type string $decoding The 'decoding' attribute value. Possible values are 1058 * 'async' (default), 'sync', or 'auto'. Passing false or an empty 1059 * string will result in the attribute being omitted. 1060 * @type string $fetchpriority The 'fetchpriority' attribute value, whether `high`, `low`, or `auto`. 1061 * Default determined by {@see wp_get_loading_optimization_attributes()}. 1062 * } 1063 * @return string HTML img element or empty string on failure. 1064 */ 1065 function wp_get_attachment_image( $attachment_id, $size = 'thumbnail', $icon = false, $attr = '' ) { 1066 $html = ''; 1067 $image = wp_get_attachment_image_src( $attachment_id, $size, $icon ); 1068 1069 if ( $image ) { 1070 list( $src, $width, $height ) = $image; 1071 1072 $attachment = get_post( $attachment_id ); 1073 $size_class = $size; 1074 1075 if ( is_array( $size_class ) ) { 1076 $size_class = implode( 'x', $size_class ); 1077 } 1078 1079 $default_attr = array( 1080 'src' => $src, 1081 'class' => "attachment-$size_class size-$size_class", 1082 'alt' => trim( strip_tags( get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ) ) ), 1083 ); 1084 1085 /** 1086 * Filters the context in which wp_get_attachment_image() is used. 1087 * 1088 * @since 6.3.0 1089 * 1090 * @param string $context The context. Default 'wp_get_attachment_image'. 1091 */ 1092 $context = apply_filters( 'wp_get_attachment_image_context', 'wp_get_attachment_image' ); 1093 1094 $attr = wp_parse_args( $attr, $default_attr ); 1095 $attr['width'] = $width; 1096 $attr['height'] = $height; 1097 1098 $loading_optimization_attr = wp_get_loading_optimization_attributes( 1099 'img', 1100 $attr, 1101 $context 1102 ); 1103 1104 // Add loading optimization attributes if not available. 1105 $attr = array_merge( $attr, $loading_optimization_attr ); 1106 1107 // Omit the `decoding` attribute if the value is invalid according to the spec. 1108 if ( empty( $attr['decoding'] ) || ! in_array( $attr['decoding'], array( 'async', 'sync', 'auto' ), true ) ) { 1109 unset( $attr['decoding'] ); 1110 } 1111 1112 /* 1113 * If the default value of `lazy` for the `loading` attribute is overridden 1114 * to omit the attribute for this image, ensure it is not included. 1115 */ 1116 if ( isset( $attr['loading'] ) && ! $attr['loading'] ) { 1117 unset( $attr['loading'] ); 1118 } 1119 1120 // If the `fetchpriority` attribute is overridden and set to false or an empty string. 1121 if ( isset( $attr['fetchpriority'] ) && ! $attr['fetchpriority'] ) { 1122 unset( $attr['fetchpriority'] ); 1123 } 1124 1125 // Generate 'srcset' and 'sizes' if not already present. 1126 if ( empty( $attr['srcset'] ) ) { 1127 $image_meta = wp_get_attachment_metadata( $attachment_id ); 1128 1129 if ( is_array( $image_meta ) ) { 1130 $size_array = array( absint( $width ), absint( $height ) ); 1131 $srcset = wp_calculate_image_srcset( $size_array, $src, $image_meta, $attachment_id ); 1132 $sizes = wp_calculate_image_sizes( $size_array, $src, $image_meta, $attachment_id ); 1133 1134 if ( $srcset && ( $sizes || ! empty( $attr['sizes'] ) ) ) { 1135 $attr['srcset'] = $srcset; 1136 1137 if ( empty( $attr['sizes'] ) ) { 1138 $attr['sizes'] = $sizes; 1139 } 1140 } 1141 } 1142 } 1143 1144 /** This filter is documented in wp-includes/media.php */ 1145 $add_auto_sizes = apply_filters( 'wp_img_tag_add_auto_sizes', true ); 1146 1147 // Adds 'auto' to the sizes attribute if applicable. 1148 if ( 1149 $add_auto_sizes && 1150 isset( $attr['loading'] ) && 1151 'lazy' === $attr['loading'] && 1152 isset( $attr['sizes'] ) && 1153 ! wp_sizes_attribute_includes_valid_auto( $attr['sizes'] ) 1154 ) { 1155 $attr['sizes'] = 'auto, ' . $attr['sizes']; 1156 } 1157 1158 /** 1159 * Filters the list of attachment image attributes. 1160 * 1161 * @since 2.8.0 1162 * @since 6.8.2 The `$attr` array includes `width` and `height` attributes. 1163 * 1164 * @param string[] $attr Array of attribute values for the image markup, keyed by attribute name. 1165 * See wp_get_attachment_image(). 1166 * @param WP_Post $attachment Image attachment post. 1167 * @param string|int[] $size Requested image size. Can be any registered image size name, or 1168 * an array of width and height values in pixels (in that order). 1169 */ 1170 $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment, $size ); 1171 1172 if ( isset( $attr['width'] ) && is_numeric( $attr['width'] ) ) { 1173 $width = absint( $attr['width'] ); 1174 } 1175 if ( isset( $attr['height'] ) && is_numeric( $attr['height'] ) ) { 1176 $height = absint( $attr['height'] ); 1177 } 1178 unset( $attr['width'], $attr['height'] ); 1179 1180 $attr = array_map( 'esc_attr', $attr ); 1181 $hwstring = image_hwstring( $width, $height ); 1182 $html = rtrim( "<img $hwstring" ); 1183 1184 foreach ( $attr as $name => $value ) { 1185 $html .= " $name=" . '"' . $value . '"'; 1186 } 1187 1188 $html .= ' />'; 1189 } 1190 1191 /** 1192 * Filters the HTML img element representing an image attachment. 1193 * 1194 * @since 5.6.0 1195 * 1196 * @param string $html HTML img element or empty string on failure. 1197 * @param int $attachment_id Image attachment ID. 1198 * @param string|int[] $size Requested image size. Can be any registered image size name, or 1199 * an array of width and height values in pixels (in that order). 1200 * @param bool $icon Whether the image should be treated as an icon. 1201 * @param string[] $attr Array of attribute values for the image markup, keyed by attribute name. 1202 * See wp_get_attachment_image(). 1203 */ 1204 return apply_filters( 'wp_get_attachment_image', $html, $attachment_id, $size, $icon, $attr ); 1205 } 1206 1207 /** 1208 * Gets the URL of an image attachment. 1209 * 1210 * @since 4.4.0 1211 * 1212 * @param int $attachment_id Image attachment ID. 1213 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of 1214 * width and height values in pixels (in that order). Default 'thumbnail'. 1215 * @param bool $icon Optional. Whether the image should be treated as an icon. Default false. 1216 * @return string|false Attachment URL or false if no image is available. If `$size` does not match 1217 * any registered image size, the original image URL will be returned. 1218 */ 1219 function wp_get_attachment_image_url( $attachment_id, $size = 'thumbnail', $icon = false ) { 1220 $image = wp_get_attachment_image_src( $attachment_id, $size, $icon ); 1221 return isset( $image[0] ) ? $image[0] : false; 1222 } 1223 1224 /** 1225 * Gets the attachment path relative to the upload directory. 1226 * 1227 * @since 4.4.1 1228 * @access private 1229 * 1230 * @param string $file Attachment file name. 1231 * @return string Attachment path relative to the upload directory. 1232 */ 1233 function _wp_get_attachment_relative_path( $file ) { 1234 $dirname = dirname( $file ); 1235 1236 if ( '.' === $dirname ) { 1237 return ''; 1238 } 1239 1240 if ( str_contains( $dirname, 'wp-content/uploads' ) ) { 1241 // Get the directory name relative to the upload directory (back compat for pre-2.7 uploads). 1242 $dirname = substr( $dirname, strpos( $dirname, 'wp-content/uploads' ) + 18 ); 1243 $dirname = ltrim( $dirname, '/' ); 1244 } 1245 1246 return $dirname; 1247 } 1248 1249 /** 1250 * Gets the image size as array from its meta data. 1251 * 1252 * Used for responsive images. 1253 * 1254 * @since 4.4.0 1255 * @access private 1256 * 1257 * @param string $size_name Image size. Accepts any registered image size name. 1258 * @param array $image_meta The image meta data. 1259 * @return array|false { 1260 * Array of width and height or false if the size isn't present in the meta data. 1261 * 1262 * @type int $0 Image width. 1263 * @type int $1 Image height. 1264 * } 1265 */ 1266 function _wp_get_image_size_from_meta( $size_name, $image_meta ) { 1267 if ( 'full' === $size_name ) { 1268 return array( 1269 absint( $image_meta['width'] ), 1270 absint( $image_meta['height'] ), 1271 ); 1272 } elseif ( ! empty( $image_meta['sizes'][ $size_name ] ) ) { 1273 return array( 1274 absint( $image_meta['sizes'][ $size_name ]['width'] ), 1275 absint( $image_meta['sizes'][ $size_name ]['height'] ), 1276 ); 1277 } 1278 1279 return false; 1280 } 1281 1282 /** 1283 * Retrieves the value for an image attachment's 'srcset' attribute. 1284 * 1285 * @since 4.4.0 1286 * 1287 * @see wp_calculate_image_srcset() 1288 * 1289 * @param int $attachment_id Image attachment ID. 1290 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of 1291 * width and height values in pixels (in that order). Default 'medium'. 1292 * @param array|null $image_meta Optional. The image meta data as returned by 'wp_get_attachment_metadata()'. 1293 * Default null. 1294 * @return string|false A 'srcset' value string or false. 1295 */ 1296 function wp_get_attachment_image_srcset( $attachment_id, $size = 'medium', $image_meta = null ) { 1297 $image = wp_get_attachment_image_src( $attachment_id, $size ); 1298 1299 if ( ! $image ) { 1300 return false; 1301 } 1302 1303 if ( ! is_array( $image_meta ) ) { 1304 $image_meta = wp_get_attachment_metadata( $attachment_id ); 1305 } 1306 1307 $image_src = $image[0]; 1308 $size_array = array( 1309 absint( $image[1] ), 1310 absint( $image[2] ), 1311 ); 1312 1313 return wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id ); 1314 } 1315 1316 /** 1317 * A helper function to calculate the image sources to include in a 'srcset' attribute. 1318 * 1319 * @since 4.4.0 1320 * 1321 * @param int[] $size_array { 1322 * An array of width and height values. 1323 * 1324 * @type int $0 The width in pixels. 1325 * @type int $1 The height in pixels. 1326 * } 1327 * @param string $image_src The 'src' of the image. 1328 * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. 1329 * @param int $attachment_id Optional. The image attachment ID. Default 0. 1330 * @return string|false The 'srcset' attribute value. False on error or when only one source exists. 1331 */ 1332 function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id = 0 ) { 1333 /** 1334 * Pre-filters the image meta to be able to fix inconsistencies in the stored data. 1335 * 1336 * @since 4.5.0 1337 * 1338 * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. 1339 * @param int[] $size_array { 1340 * An array of requested width and height values. 1341 * 1342 * @type int $0 The width in pixels. 1343 * @type int $1 The height in pixels. 1344 * } 1345 * @param string $image_src The 'src' of the image. 1346 * @param int $attachment_id The image attachment ID or 0 if not supplied. 1347 */ 1348 $image_meta = apply_filters( 'wp_calculate_image_srcset_meta', $image_meta, $size_array, $image_src, $attachment_id ); 1349 1350 if ( empty( $image_meta['sizes'] ) || ! isset( $image_meta['file'] ) || strlen( $image_meta['file'] ) < 4 ) { 1351 return false; 1352 } 1353 1354 $image_sizes = $image_meta['sizes']; 1355 1356 // Get the width and height of the image. 1357 $image_width = (int) $size_array[0]; 1358 $image_height = (int) $size_array[1]; 1359 1360 // Bail early if error/no width. 1361 if ( $image_width < 1 ) { 1362 return false; 1363 } 1364 1365 $image_basename = wp_basename( $image_meta['file'] ); 1366 1367 /* 1368 * WordPress flattens animated GIFs into one frame when generating intermediate sizes. 1369 * To avoid hiding animation in user content, if src is a full size GIF, a srcset attribute is not generated. 1370 * If src is an intermediate size GIF, the full size is excluded from srcset to keep a flattened GIF from becoming animated. 1371 */ 1372 if ( ! isset( $image_sizes['thumbnail']['mime-type'] ) || 'image/gif' !== $image_sizes['thumbnail']['mime-type'] ) { 1373 $image_sizes[] = array( 1374 'width' => $image_meta['width'], 1375 'height' => $image_meta['height'], 1376 'file' => $image_basename, 1377 ); 1378 } elseif ( str_contains( $image_src, $image_meta['file'] ) ) { 1379 return false; 1380 } 1381 1382 // Retrieve the uploads sub-directory from the full size image. 1383 $dirname = _wp_get_attachment_relative_path( $image_meta['file'] ); 1384 1385 if ( $dirname ) { 1386 $dirname = trailingslashit( $dirname ); 1387 } 1388 1389 $upload_dir = wp_get_upload_dir(); 1390 $image_baseurl = trailingslashit( $upload_dir['baseurl'] ) . $dirname; 1391 1392 /* 1393 * If currently on HTTPS, prefer HTTPS URLs when we know they're supported by the domain 1394 * (which is to say, when they share the domain name of the current request). 1395 */ 1396 if ( is_ssl() && ! str_starts_with( $image_baseurl, 'https' ) ) { 1397 /* 1398 * Since the `Host:` header might contain a port, it should 1399 * be compared against the image URL using the same port. 1400 */ 1401 $parsed = parse_url( $image_baseurl ); 1402 $domain = isset( $parsed['host'] ) ? $parsed['host'] : ''; 1403 1404 if ( isset( $parsed['port'] ) ) { 1405 $domain .= ':' . $parsed['port']; 1406 } 1407 1408 if ( $_SERVER['HTTP_HOST'] === $domain ) { 1409 $image_baseurl = set_url_scheme( $image_baseurl, 'https' ); 1410 } 1411 } 1412 1413 /* 1414 * Images that have been edited in WordPress after being uploaded will 1415 * contain a unique hash. Look for that hash and use it later to filter 1416 * out images that are leftovers from previous versions. 1417 */ 1418 $image_edited = preg_match( '/-e[0-9]{13}/', wp_basename( $image_src ), $image_edit_hash ); 1419 1420 /** 1421 * Filters the maximum image width to be included in a 'srcset' attribute. 1422 * 1423 * @since 4.4.0 1424 * 1425 * @param int $max_width The maximum image width to be included in the 'srcset'. Default '2048'. 1426 * @param int[] $size_array { 1427 * An array of requested width and height values. 1428 * 1429 * @type int $0 The width in pixels. 1430 * @type int $1 The height in pixels. 1431 * } 1432 */ 1433 $max_srcset_image_width = apply_filters( 'max_srcset_image_width', 2048, $size_array ); 1434 1435 // Array to hold URL candidates. 1436 $sources = array(); 1437 1438 /** 1439 * To make sure the ID matches our image src, we will check to see if any sizes in our attachment 1440 * meta match our $image_src. If no matches are found we don't return a srcset to avoid serving 1441 * an incorrect image. See #35045. 1442 */ 1443 $src_matched = false; 1444 1445 /* 1446 * Loop through available images. Only use images that are resized 1447 * versions of the same edit. 1448 */ 1449 foreach ( $image_sizes as $image ) { 1450 $is_src = false; 1451 1452 // Check if image meta isn't corrupted. 1453 if ( ! is_array( $image ) ) { 1454 continue; 1455 } 1456 1457 // If the file name is part of the `src`, we've confirmed a match. 1458 if ( ! $src_matched && str_contains( $image_src, $dirname . $image['file'] ) ) { 1459 $src_matched = true; 1460 $is_src = true; 1461 } 1462 1463 // Filter out images that are from previous edits. 1464 if ( $image_edited && ! strpos( $image['file'], $image_edit_hash[0] ) ) { 1465 continue; 1466 } 1467 1468 /* 1469 * Filters out images that are wider than '$max_srcset_image_width' unless 1470 * that file is in the 'src' attribute. 1471 */ 1472 if ( $max_srcset_image_width && $image['width'] > $max_srcset_image_width && ! $is_src ) { 1473 continue; 1474 } 1475 1476 // If the image dimensions are within 1px of the expected size, use it. 1477 if ( wp_image_matches_ratio( $image_width, $image_height, $image['width'], $image['height'] ) ) { 1478 // Add the URL, descriptor, and value to the sources array to be returned. 1479 $source = array( 1480 'url' => $image_baseurl . $image['file'], 1481 'descriptor' => 'w', 1482 'value' => $image['width'], 1483 ); 1484 1485 // The 'src' image has to be the first in the 'srcset', because of a bug in iOS8. See #35030. 1486 if ( $is_src ) { 1487 $sources = array( $image['width'] => $source ) + $sources; 1488 } else { 1489 $sources[ $image['width'] ] = $source; 1490 } 1491 } 1492 } 1493 1494 /** 1495 * Filters an image's 'srcset' sources. 1496 * 1497 * @since 4.4.0 1498 * 1499 * @param array $sources { 1500 * One or more arrays of source data to include in the 'srcset'. 1501 * 1502 * @type array $width { 1503 * @type string $url The URL of an image source. 1504 * @type string $descriptor The descriptor type used in the image candidate string, 1505 * either 'w' or 'x'. 1506 * @type int $value The source width if paired with a 'w' descriptor, or a 1507 * pixel density value if paired with an 'x' descriptor. 1508 * } 1509 * } 1510 * @param array $size_array { 1511 * An array of requested width and height values. 1512 * 1513 * @type int $0 The width in pixels. 1514 * @type int $1 The height in pixels. 1515 * } 1516 * @param string $image_src The 'src' of the image. 1517 * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. 1518 * @param int $attachment_id Image attachment ID or 0. 1519 */ 1520 $sources = apply_filters( 'wp_calculate_image_srcset', $sources, $size_array, $image_src, $image_meta, $attachment_id ); 1521 1522 // Only return a 'srcset' value if there is more than one source. 1523 if ( ! $src_matched || ! is_array( $sources ) || count( $sources ) < 2 ) { 1524 return false; 1525 } 1526 1527 $srcset = ''; 1528 1529 foreach ( $sources as $source ) { 1530 $srcset .= str_replace( ' ', '%20', $source['url'] ) . ' ' . $source['value'] . $source['descriptor'] . ', '; 1531 } 1532 1533 return rtrim( $srcset, ', ' ); 1534 } 1535 1536 /** 1537 * Retrieves the value for an image attachment's 'sizes' attribute. 1538 * 1539 * @since 4.4.0 1540 * 1541 * @see wp_calculate_image_sizes() 1542 * 1543 * @param int $attachment_id Image attachment ID. 1544 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of 1545 * width and height values in pixels (in that order). Default 'medium'. 1546 * @param array|null $image_meta Optional. The image meta data as returned by 'wp_get_attachment_metadata()'. 1547 * Default null. 1548 * @return string|false A valid source size value for use in a 'sizes' attribute or false. 1549 */ 1550 function wp_get_attachment_image_sizes( $attachment_id, $size = 'medium', $image_meta = null ) { 1551 $image = wp_get_attachment_image_src( $attachment_id, $size ); 1552 1553 if ( ! $image ) { 1554 return false; 1555 } 1556 1557 if ( ! is_array( $image_meta ) ) { 1558 $image_meta = wp_get_attachment_metadata( $attachment_id ); 1559 } 1560 1561 $image_src = $image[0]; 1562 $size_array = array( 1563 absint( $image[1] ), 1564 absint( $image[2] ), 1565 ); 1566 1567 return wp_calculate_image_sizes( $size_array, $image_src, $image_meta, $attachment_id ); 1568 } 1569 1570 /** 1571 * Creates a 'sizes' attribute value for an image. 1572 * 1573 * @since 4.4.0 1574 * 1575 * @param string|int[] $size Image size. Accepts any registered image size name, or an array of 1576 * width and height values in pixels (in that order). 1577 * @param string|null $image_src Optional. The URL to the image file. Default null. 1578 * @param array|null $image_meta Optional. The image meta data as returned by 'wp_get_attachment_metadata()'. 1579 * Default null. 1580 * @param int $attachment_id Optional. Image attachment ID. Either `$image_meta` or `$attachment_id` 1581 * is needed when using the image size name as argument for `$size`. Default 0. 1582 * @return string|false A valid source size value for use in a 'sizes' attribute or false. 1583 */ 1584 function wp_calculate_image_sizes( $size, $image_src = null, $image_meta = null, $attachment_id = 0 ) { 1585 $width = 0; 1586 1587 if ( is_array( $size ) ) { 1588 $width = absint( $size[0] ); 1589 } elseif ( is_string( $size ) ) { 1590 if ( ! $image_meta && $attachment_id ) { 1591 $image_meta = wp_get_attachment_metadata( $attachment_id ); 1592 } 1593 1594 if ( is_array( $image_meta ) ) { 1595 $size_array = _wp_get_image_size_from_meta( $size, $image_meta ); 1596 if ( $size_array ) { 1597 $width = absint( $size_array[0] ); 1598 } 1599 } 1600 } 1601 1602 if ( ! $width ) { 1603 return false; 1604 } 1605 1606 // Setup the default 'sizes' attribute. 1607 $sizes = sprintf( '(max-width: %1$dpx) 100vw, %1$dpx', $width ); 1608 1609 /** 1610 * Filters the output of 'wp_calculate_image_sizes()'. 1611 * 1612 * @since 4.4.0 1613 * 1614 * @param string $sizes A source size value for use in a 'sizes' attribute. 1615 * @param string|int[] $size Requested image size. Can be any registered image size name, or 1616 * an array of width and height values in pixels (in that order). 1617 * @param string|null $image_src The URL to the image file or null. 1618 * @param array|null $image_meta The image meta data as returned by wp_get_attachment_metadata() or null. 1619 * @param int $attachment_id Image attachment ID of the original image or 0. 1620 */ 1621 return apply_filters( 'wp_calculate_image_sizes', $sizes, $size, $image_src, $image_meta, $attachment_id ); 1622 } 1623 1624 /** 1625 * Determines if the image meta data is for the image source file. 1626 * 1627 * The image meta data is retrieved by attachment post ID. In some cases the post IDs may change. 1628 * For example when the website is exported and imported at another website. Then the 1629 * attachment post IDs that are in post_content for the exported website may not match 1630 * the same attachments at the new website. 1631 * 1632 * @since 5.5.0 1633 * 1634 * @param string $image_location The full path or URI to the image file. 1635 * @param array $image_meta The attachment meta data as returned by 'wp_get_attachment_metadata()'. 1636 * @param int $attachment_id Optional. The image attachment ID. Default 0. 1637 * @return bool Whether the image meta is for this image file. 1638 */ 1639 function wp_image_file_matches_image_meta( $image_location, $image_meta, $attachment_id = 0 ) { 1640 $match = false; 1641 1642 // Ensure the $image_meta is valid. 1643 if ( isset( $image_meta['file'] ) && strlen( $image_meta['file'] ) > 4 ) { 1644 // Remove query args in image URI. 1645 list( $image_location ) = explode( '?', $image_location ); 1646 1647 // Check if the relative image path from the image meta is at the end of $image_location. 1648 if ( strrpos( $image_location, $image_meta['file'] ) === strlen( $image_location ) - strlen( $image_meta['file'] ) ) { 1649 $match = true; 1650 } else { 1651 // Retrieve the uploads sub-directory from the full size image. 1652 $dirname = _wp_get_attachment_relative_path( $image_meta['file'] ); 1653 1654 if ( $dirname ) { 1655 $dirname = trailingslashit( $dirname ); 1656 } 1657 1658 if ( ! empty( $image_meta['original_image'] ) ) { 1659 $relative_path = $dirname . $image_meta['original_image']; 1660 1661 if ( strrpos( $image_location, $relative_path ) === strlen( $image_location ) - strlen( $relative_path ) ) { 1662 $match = true; 1663 } 1664 } 1665 1666 if ( ! $match && ! empty( $image_meta['sizes'] ) ) { 1667 foreach ( $image_meta['sizes'] as $image_size_data ) { 1668 $relative_path = $dirname . $image_size_data['file']; 1669 1670 if ( strrpos( $image_location, $relative_path ) === strlen( $image_location ) - strlen( $relative_path ) ) { 1671 $match = true; 1672 break; 1673 } 1674 } 1675 } 1676 } 1677 } 1678 1679 /** 1680 * Filters whether an image path or URI matches image meta. 1681 * 1682 * @since 5.5.0 1683 * 1684 * @param bool $match Whether the image relative path from the image meta 1685 * matches the end of the URI or path to the image file. 1686 * @param string $image_location Full path or URI to the tested image file. 1687 * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. 1688 * @param int $attachment_id The image attachment ID or 0 if not supplied. 1689 */ 1690 return apply_filters( 'wp_image_file_matches_image_meta', $match, $image_location, $image_meta, $attachment_id ); 1691 } 1692 1693 /** 1694 * Determines an image's width and height dimensions based on the source file. 1695 * 1696 * @since 5.5.0 1697 * 1698 * @param string $image_src The image source file. 1699 * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. 1700 * @param int $attachment_id Optional. The image attachment ID. Default 0. 1701 * @return array|false Array with first element being the width and second element being the height, 1702 * or false if dimensions cannot be determined. 1703 */ 1704 function wp_image_src_get_dimensions( $image_src, $image_meta, $attachment_id = 0 ) { 1705 $dimensions = false; 1706 1707 // Is it a full size image? 1708 if ( 1709 isset( $image_meta['file'] ) && 1710 str_contains( $image_src, wp_basename( $image_meta['file'] ) ) 1711 ) { 1712 $dimensions = array( 1713 (int) $image_meta['width'], 1714 (int) $image_meta['height'], 1715 ); 1716 } 1717 1718 if ( ! $dimensions && ! empty( $image_meta['sizes'] ) ) { 1719 $src_filename = wp_basename( $image_src ); 1720 1721 foreach ( $image_meta['sizes'] as $image_size_data ) { 1722 if ( $src_filename === $image_size_data['file'] ) { 1723 $dimensions = array( 1724 (int) $image_size_data['width'], 1725 (int) $image_size_data['height'], 1726 ); 1727 1728 break; 1729 } 1730 } 1731 } 1732 1733 /** 1734 * Filters the 'wp_image_src_get_dimensions' value. 1735 * 1736 * @since 5.7.0 1737 * 1738 * @param array|false $dimensions Array with first element being the width 1739 * and second element being the height, or 1740 * false if dimensions could not be determined. 1741 * @param string $image_src The image source file. 1742 * @param array $image_meta The image meta data as returned by 1743 * 'wp_get_attachment_metadata()'. 1744 * @param int $attachment_id The image attachment ID. Default 0. 1745 */ 1746 return apply_filters( 'wp_image_src_get_dimensions', $dimensions, $image_src, $image_meta, $attachment_id ); 1747 } 1748 1749 /** 1750 * Adds 'srcset' and 'sizes' attributes to an existing 'img' element. 1751 * 1752 * @since 4.4.0 1753 * 1754 * @see wp_calculate_image_srcset() 1755 * @see wp_calculate_image_sizes() 1756 * 1757 * @param string $image An HTML 'img' element to be filtered. 1758 * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. 1759 * @param int $attachment_id Image attachment ID. 1760 * @return string Converted 'img' element with 'srcset' and 'sizes' attributes added. 1761 */ 1762 function wp_image_add_srcset_and_sizes( $image, $image_meta, $attachment_id ) { 1763 // Ensure the image meta exists. 1764 if ( empty( $image_meta['sizes'] ) ) { 1765 return $image; 1766 } 1767 1768 $image_src = preg_match( '/src="([^"]+)"/', $image, $match_src ) ? $match_src[1] : ''; 1769 list( $image_src ) = explode( '?', $image_src ); 1770 1771 // Return early if we couldn't get the image source. 1772 if ( ! $image_src ) { 1773 return $image; 1774 } 1775 1776 // Bail early if an image has been inserted and later edited. 1777 if ( preg_match( '/-e[0-9]{13}/', $image_meta['file'], $img_edit_hash ) 1778 && ! str_contains( wp_basename( $image_src ), $img_edit_hash[0] ) 1779 ) { 1780 return $image; 1781 } 1782 1783 $width = preg_match( '/ width="([0-9]+)"/', $image, $match_width ) ? (int) $match_width[1] : 0; 1784 $height = preg_match( '/ height="([0-9]+)"/', $image, $match_height ) ? (int) $match_height[1] : 0; 1785 1786 if ( $width && $height ) { 1787 $size_array = array( $width, $height ); 1788 } else { 1789 $size_array = wp_image_src_get_dimensions( $image_src, $image_meta, $attachment_id ); 1790 if ( ! $size_array ) { 1791 return $image; 1792 } 1793 } 1794 1795 $srcset = wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id ); 1796 1797 if ( $srcset ) { 1798 // Check if there is already a 'sizes' attribute. 1799 $sizes = strpos( $image, ' sizes=' ); 1800 1801 if ( ! $sizes ) { 1802 $sizes = wp_calculate_image_sizes( $size_array, $image_src, $image_meta, $attachment_id ); 1803 } 1804 } 1805 1806 if ( $srcset && $sizes ) { 1807 // Format the 'srcset' and 'sizes' string and escape attributes. 1808 $attr = sprintf( ' srcset="%s"', esc_attr( $srcset ) ); 1809 1810 if ( is_string( $sizes ) ) { 1811 $attr .= sprintf( ' sizes="%s"', esc_attr( $sizes ) ); 1812 } 1813 1814 // Add the srcset and sizes attributes to the image markup. 1815 return preg_replace( '/<img ([^>]+?)[\/ ]*>/', '<img $1' . $attr . ' />', $image ); 1816 } 1817 1818 return $image; 1819 } 1820 1821 /** 1822 * Determines whether to add the `loading` attribute to the specified tag in the specified context. 1823 * 1824 * @since 5.5.0 1825 * @since 5.7.0 Now returns `true` by default for `iframe` tags. 1826 * 1827 * @param string $tag_name The tag name. 1828 * @param string $context Additional context, like the current filter name 1829 * or the function name from where this was called. 1830 * @return bool Whether to add the attribute. 1831 */ 1832 function wp_lazy_loading_enabled( $tag_name, $context ) { 1833 /* 1834 * By default add to all 'img' and 'iframe' tags. 1835 * See https://html.spec.whatwg.org/multipage/embedded-content.html#attr-img-loading 1836 * See https://html.spec.whatwg.org/multipage/iframe-embed-object.html#attr-iframe-loading 1837 */ 1838 $default = ( 'img' === $tag_name || 'iframe' === $tag_name ); 1839 1840 /** 1841 * Filters whether to add the `loading` attribute to the specified tag in the specified context. 1842 * 1843 * @since 5.5.0 1844 * 1845 * @param bool $default Default value. 1846 * @param string $tag_name The tag name. 1847 * @param string $context Additional context, like the current filter name 1848 * or the function name from where this was called. 1849 */ 1850 return (bool) apply_filters( 'wp_lazy_loading_enabled', $default, $tag_name, $context ); 1851 } 1852 1853 /** 1854 * Filters specific tags in post content and modifies their markup. 1855 * 1856 * Modifies HTML tags in post content to include new browser and HTML technologies 1857 * that may not have existed at the time of post creation. These modifications currently 1858 * include adding `srcset`, `sizes`, and `loading` attributes to `img` HTML tags, as well 1859 * as adding `loading` attributes to `iframe` HTML tags. 1860 * Future similar optimizations should be added/expected here. 1861 * 1862 * @since 5.5.0 1863 * @since 5.7.0 Now supports adding `loading` attributes to `iframe` tags. 1864 * 1865 * @see wp_img_tag_add_width_and_height_attr() 1866 * @see wp_img_tag_add_srcset_and_sizes_attr() 1867 * @see wp_img_tag_add_loading_optimization_attrs() 1868 * @see wp_iframe_tag_add_loading_attr() 1869 * 1870 * @param string $content The HTML content to be filtered. 1871 * @param string $context Optional. Additional context to pass to the filters. 1872 * Defaults to `current_filter()` when not set. 1873 * @return string Converted content with images modified. 1874 */ 1875 function wp_filter_content_tags( $content, $context = null ) { 1876 if ( null === $context ) { 1877 $context = current_filter(); 1878 } 1879 1880 $add_iframe_loading_attr = wp_lazy_loading_enabled( 'iframe', $context ); 1881 1882 if ( ! preg_match_all( '/<(img|iframe)\s[^>]+>/', $content, $matches, PREG_SET_ORDER ) ) { 1883 return $content; 1884 } 1885 1886 // List of the unique `img` tags found in $content. 1887 $images = array(); 1888 1889 // List of the unique `iframe` tags found in $content. 1890 $iframes = array(); 1891 1892 foreach ( $matches as $match ) { 1893 list( $tag, $tag_name ) = $match; 1894 1895 switch ( $tag_name ) { 1896 case 'img': 1897 if ( preg_match( '/wp-image-([0-9]+)/i', $tag, $class_id ) ) { 1898 $attachment_id = absint( $class_id[1] ); 1899 1900 if ( $attachment_id ) { 1901 /* 1902 * If exactly the same image tag is used more than once, overwrite it. 1903 * All identical tags will be replaced later with 'str_replace()'. 1904 */ 1905 $images[ $tag ] = $attachment_id; 1906 break; 1907 } 1908 } 1909 $images[ $tag ] = 0; 1910 break; 1911 case 'iframe': 1912 $iframes[ $tag ] = 0; 1913 break; 1914 } 1915 } 1916 1917 // Reduce the array to unique attachment IDs. 1918 $attachment_ids = array_unique( array_filter( array_values( $images ) ) ); 1919 1920 if ( count( $attachment_ids ) > 1 ) { 1921 /* 1922 * Warm the object cache with post and meta information for all found 1923 * images to avoid making individual database calls. 1924 */ 1925 _prime_post_caches( $attachment_ids, false, true ); 1926 } 1927 1928 // Iterate through the matches in order of occurrence as it is relevant for whether or not to lazy-load. 1929 foreach ( $matches as $match ) { 1930 // Filter an image match. 1931 if ( isset( $images[ $match[0] ] ) ) { 1932 $filtered_image = $match[0]; 1933 $attachment_id = $images[ $match[0] ]; 1934 1935 // Add 'width' and 'height' attributes if applicable. 1936 if ( $attachment_id > 0 && ! str_contains( $filtered_image, ' width=' ) && ! str_contains( $filtered_image, ' height=' ) ) { 1937 $filtered_image = wp_img_tag_add_width_and_height_attr( $filtered_image, $context, $attachment_id ); 1938 } 1939 1940 // Add 'srcset' and 'sizes' attributes if applicable. 1941 if ( $attachment_id > 0 && ! str_contains( $filtered_image, ' srcset=' ) ) { 1942 $filtered_image = wp_img_tag_add_srcset_and_sizes_attr( $filtered_image, $context, $attachment_id ); 1943 } 1944 1945 // Add loading optimization attributes if applicable. 1946 $filtered_image = wp_img_tag_add_loading_optimization_attrs( $filtered_image, $context ); 1947 1948 // Adds 'auto' to the sizes attribute if applicable. 1949 $filtered_image = wp_img_tag_add_auto_sizes( $filtered_image ); 1950 1951 /** 1952 * Filters an img tag within the content for a given context. 1953 * 1954 * @since 6.0.0 1955 * 1956 * @param string $filtered_image Full img tag with attributes that will replace the source img tag. 1957 * @param string $context Additional context, like the current filter name or the function name from where this was called. 1958 * @param int $attachment_id The image attachment ID. May be 0 in case the image is not an attachment. 1959 */ 1960 $filtered_image = apply_filters( 'wp_content_img_tag', $filtered_image, $context, $attachment_id ); 1961 1962 if ( $filtered_image !== $match[0] ) { 1963 $content = str_replace( $match[0], $filtered_image, $content ); 1964 } 1965 1966 /* 1967 * Unset image lookup to not run the same logic again unnecessarily if the same image tag is used more than 1968 * once in the same blob of content. 1969 */ 1970 unset( $images[ $match[0] ] ); 1971 } 1972 1973 // Filter an iframe match. 1974 if ( isset( $iframes[ $match[0] ] ) ) { 1975 $filtered_iframe = $match[0]; 1976 1977 // Add 'loading' attribute if applicable. 1978 if ( $add_iframe_loading_attr && ! str_contains( $filtered_iframe, ' loading=' ) ) { 1979 $filtered_iframe = wp_iframe_tag_add_loading_attr( $filtered_iframe, $context ); 1980 } 1981 1982 if ( $filtered_iframe !== $match[0] ) { 1983 $content = str_replace( $match[0], $filtered_iframe, $content ); 1984 } 1985 1986 /* 1987 * Unset iframe lookup to not run the same logic again unnecessarily if the same iframe tag is used more 1988 * than once in the same blob of content. 1989 */ 1990 unset( $iframes[ $match[0] ] ); 1991 } 1992 } 1993 1994 return $content; 1995 } 1996 1997 /** 1998 * Adds 'auto' to the sizes attribute to the image, if the image is lazy loaded and does not already include it. 1999 * 2000 * @since 6.7.0 2001 * 2002 * @param string $image The image tag markup being filtered. 2003 * @return string The filtered image tag markup. 2004 */ 2005 function wp_img_tag_add_auto_sizes( string $image ): string { 2006 /** 2007 * Filters whether auto-sizes for lazy loaded images is enabled. 2008 * 2009 * @since 6.7.1 2010 * 2011 * @param boolean $enabled Whether auto-sizes for lazy loaded images is enabled. 2012 */ 2013 if ( ! apply_filters( 'wp_img_tag_add_auto_sizes', true ) ) { 2014 return $image; 2015 } 2016 2017 $processor = new WP_HTML_Tag_Processor( $image ); 2018 2019 // Bail if there is no IMG tag. 2020 if ( ! $processor->next_tag( array( 'tag_name' => 'IMG' ) ) ) { 2021 return $image; 2022 } 2023 2024 // Bail early if the image is not lazy-loaded. 2025 $loading = $processor->get_attribute( 'loading' ); 2026 if ( ! is_string( $loading ) || 'lazy' !== strtolower( trim( $loading, " \t\f\r\n" ) ) ) { 2027 return $image; 2028 } 2029 2030 /* 2031 * Bail early if the image doesn't have a width attribute. 2032 * Per WordPress Core itself, lazy-loaded images should always have a width attribute. 2033 * However, it is possible that lazy-loading could be added by a plugin, where we don't have that guarantee. 2034 * As such, it still makes sense to ensure presence of a width attribute here in order to use `sizes=auto`. 2035 */ 2036 $width = $processor->get_attribute( 'width' ); 2037 if ( ! is_string( $width ) || '' === $width ) { 2038 return $image; 2039 } 2040 2041 $sizes = $processor->get_attribute( 'sizes' ); 2042 2043 // Bail early if the image is not responsive. 2044 if ( ! is_string( $sizes ) ) { 2045 return $image; 2046 } 2047 2048 // Don't add 'auto' to the sizes attribute if it already exists. 2049 if ( wp_sizes_attribute_includes_valid_auto( $sizes ) ) { 2050 return $image; 2051 } 2052 2053 $processor->set_attribute( 'sizes', "auto, $sizes" ); 2054 return $processor->get_updated_html(); 2055 } 2056 2057 /** 2058 * Checks whether the given 'sizes' attribute includes the 'auto' keyword as the first item in the list. 2059 * 2060 * Per the HTML spec, if present it must be the first entry. 2061 * 2062 * @since 6.7.0 2063 * 2064 * @param string $sizes_attr The 'sizes' attribute value. 2065 * @return bool True if the 'auto' keyword is present, false otherwise. 2066 */ 2067 function wp_sizes_attribute_includes_valid_auto( string $sizes_attr ): bool { 2068 list( $first_size ) = explode( ',', $sizes_attr, 2 ); 2069 return 'auto' === strtolower( trim( $first_size, " \t\f\r\n" ) ); 2070 } 2071 2072 /** 2073 * Prints a CSS rule to fix potential visual issues with images using `sizes=auto`. 2074 * 2075 * This rule overrides the similar rule in the default user agent stylesheet, to avoid images that use e.g. 2076 * `width: auto` or `width: fit-content` to appear smaller. 2077 * 2078 * @since 6.7.1 2079 * @see https://html.spec.whatwg.org/multipage/rendering.html#img-contain-size 2080 * @see https://core.trac.wordpress.org/ticket/62413 2081 */ 2082 function wp_print_auto_sizes_contain_css_fix() { 2083 /** This filter is documented in wp-includes/media.php */ 2084 $add_auto_sizes = apply_filters( 'wp_img_tag_add_auto_sizes', true ); 2085 if ( ! $add_auto_sizes ) { 2086 return; 2087 } 2088 2089 ?> 2090 <style>img:is([sizes="auto" i], [sizes^="auto," i]) { contain-intrinsic-size: 3000px 1500px }</style> 2091 <?php 2092 } 2093 2094 /** 2095 * Adds optimization attributes to an `img` HTML tag. 2096 * 2097 * @since 6.3.0 2098 * 2099 * @param string $image The HTML `img` tag where the attribute should be added. 2100 * @param string $context Additional context to pass to the filters. 2101 * @return string Converted `img` tag with optimization attributes added. 2102 */ 2103 function wp_img_tag_add_loading_optimization_attrs( $image, $context ) { 2104 $src = preg_match( '/ src=["\']?([^"\']*)/i', $image, $matche_src ) ? $matche_src[1] : null; 2105 $width = preg_match( '/ width=["\']([0-9]+)["\']/', $image, $match_width ) ? (int) $match_width[1] : null; 2106 $height = preg_match( '/ height=["\']([0-9]+)["\']/', $image, $match_height ) ? (int) $match_height[1] : null; 2107 $loading_val = preg_match( '/ loading=["\']([A-Za-z]+)["\']/', $image, $match_loading ) ? $match_loading[1] : null; 2108 $fetchpriority_val = preg_match( '/ fetchpriority=["\']([A-Za-z]+)["\']/', $image, $match_fetchpriority ) ? $match_fetchpriority[1] : null; 2109 $decoding_val = preg_match( '/ decoding=["\']([A-Za-z]+)["\']/', $image, $match_decoding ) ? $match_decoding[1] : null; 2110 2111 /* 2112 * Get loading optimization attributes to use. 2113 * This must occur before the conditional check below so that even images 2114 * that are ineligible for being lazy-loaded are considered. 2115 */ 2116 $optimization_attrs = wp_get_loading_optimization_attributes( 2117 'img', 2118 array( 2119 'src' => $src, 2120 'width' => $width, 2121 'height' => $height, 2122 'loading' => $loading_val, 2123 'fetchpriority' => $fetchpriority_val, 2124 'decoding' => $decoding_val, 2125 ), 2126 $context 2127 ); 2128 2129 // Images should have source for the loading optimization attributes to be added. 2130 if ( ! str_contains( $image, ' src="' ) ) { 2131 return $image; 2132 } 2133 2134 if ( empty( $decoding_val ) ) { 2135 /** 2136 * Filters the `decoding` attribute value to add to an image. Default `async`. 2137 * 2138 * Returning a falsey value will omit the attribute. 2139 * 2140 * @since 6.1.0 2141 * 2142 * @param string|false|null $value The `decoding` attribute value. Returning a falsey value 2143 * will result in the attribute being omitted for the image. 2144 * Otherwise, it may be: 'async', 'sync', or 'auto'. Defaults to false. 2145 * @param string $image The HTML `img` tag to be filtered. 2146 * @param string $context Additional context about how the function was called 2147 * or where the img tag is. 2148 */ 2149 $filtered_decoding_attr = apply_filters( 2150 'wp_img_tag_add_decoding_attr', 2151 isset( $optimization_attrs['decoding'] ) ? $optimization_attrs['decoding'] : false, 2152 $image, 2153 $context 2154 ); 2155 2156 // Validate the values after filtering. 2157 if ( isset( $optimization_attrs['decoding'] ) && ! $filtered_decoding_attr ) { 2158 // Unset `decoding` attribute if `$filtered_decoding_attr` is set to `false`. 2159 unset( $optimization_attrs['decoding'] ); 2160 } elseif ( in_array( $filtered_decoding_attr, array( 'async', 'sync', 'auto' ), true ) ) { 2161 $optimization_attrs['decoding'] = $filtered_decoding_attr; 2162 } 2163 2164 if ( ! empty( $optimization_attrs['decoding'] ) ) { 2165 $image = str_replace( '<img', '<img decoding="' . esc_attr( $optimization_attrs['decoding'] ) . '"', $image ); 2166 } 2167 } 2168 2169 // Images should have dimension attributes for the 'loading' and 'fetchpriority' attributes to be added. 2170 if ( ! str_contains( $image, ' width="' ) || ! str_contains( $image, ' height="' ) ) { 2171 return $image; 2172 } 2173 2174 // Retained for backward compatibility. 2175 $loading_attrs_enabled = wp_lazy_loading_enabled( 'img', $context ); 2176 2177 if ( empty( $loading_val ) && $loading_attrs_enabled ) { 2178 /** 2179 * Filters the `loading` attribute value to add to an image. Default `lazy`. 2180 * 2181 * Returning `false` or an empty string will not add the attribute. 2182 * Returning `true` will add the default value. 2183 * 2184 * @since 5.5.0 2185 * 2186 * @param string|bool $value The `loading` attribute value. Returning a falsey value will result in 2187 * the attribute being omitted for the image. 2188 * @param string $image The HTML `img` tag to be filtered. 2189 * @param string $context Additional context about how the function was called or where the img tag is. 2190 */ 2191 $filtered_loading_attr = apply_filters( 2192 'wp_img_tag_add_loading_attr', 2193 isset( $optimization_attrs['loading'] ) ? $optimization_attrs['loading'] : false, 2194 $image, 2195 $context 2196 ); 2197 2198 // Validate the values after filtering. 2199 if ( isset( $optimization_attrs['loading'] ) && ! $filtered_loading_attr ) { 2200 // Unset `loading` attributes if `$filtered_loading_attr` is set to `false`. 2201 unset( $optimization_attrs['loading'] ); 2202 } elseif ( in_array( $filtered_loading_attr, array( 'lazy', 'eager' ), true ) ) { 2203 /* 2204 * If the filter changed the loading attribute to "lazy" when a fetchpriority attribute 2205 * with value "high" is already present, trigger a warning since those two attribute 2206 * values should be mutually exclusive. 2207 * 2208 * The same warning is present in `wp_get_loading_optimization_attributes()`, and here it 2209 * is only intended for the specific scenario where the above filtered caused the problem. 2210 */ 2211 if ( isset( $optimization_attrs['fetchpriority'] ) && 'high' === $optimization_attrs['fetchpriority'] && 2212 ( isset( $optimization_attrs['loading'] ) ? $optimization_attrs['loading'] : false ) !== $filtered_loading_attr && 2213 'lazy' === $filtered_loading_attr 2214 ) { 2215 _doing_it_wrong( 2216 __FUNCTION__, 2217 __( 'An image should not be lazy-loaded and marked as high priority at the same time.' ), 2218 '6.3.0' 2219 ); 2220 } 2221 2222 // The filtered value will still be respected. 2223 $optimization_attrs['loading'] = $filtered_loading_attr; 2224 } 2225 2226 if ( ! empty( $optimization_attrs['loading'] ) ) { 2227 $image = str_replace( '<img', '<img loading="' . esc_attr( $optimization_attrs['loading'] ) . '"', $image ); 2228 } 2229 } 2230 2231 if ( empty( $fetchpriority_val ) && ! empty( $optimization_attrs['fetchpriority'] ) ) { 2232 $image = str_replace( '<img', '<img fetchpriority="' . esc_attr( $optimization_attrs['fetchpriority'] ) . '"', $image ); 2233 } 2234 2235 return $image; 2236 } 2237 2238 /** 2239 * Adds `width` and `height` attributes to an `img` HTML tag. 2240 * 2241 * @since 5.5.0 2242 * 2243 * @param string $image The HTML `img` tag where the attribute should be added. 2244 * @param string $context Additional context to pass to the filters. 2245 * @param int $attachment_id Image attachment ID. 2246 * @return string Converted 'img' element with 'width' and 'height' attributes added. 2247 */ 2248 function wp_img_tag_add_width_and_height_attr( $image, $context, $attachment_id ) { 2249 $image_src = preg_match( '/src="([^"]+)"/', $image, $match_src ) ? $match_src[1] : ''; 2250 list( $image_src ) = explode( '?', $image_src ); 2251 2252 // Return early if we couldn't get the image source. 2253 if ( ! $image_src ) { 2254 return $image; 2255 } 2256 2257 /** 2258 * Filters whether to add the missing `width` and `height` HTML attributes to the img tag. Default `true`. 2259 * 2260 * Returning anything else than `true` will not add the attributes. 2261 * 2262 * @since 5.5.0 2263 * 2264 * @param bool $value The filtered value, defaults to `true`. 2265 * @param string $image The HTML `img` tag where the attribute should be added. 2266 * @param string $context Additional context about how the function was called or where the img tag is. 2267 * @param int $attachment_id The image attachment ID. 2268 */ 2269 $add = apply_filters( 'wp_img_tag_add_width_and_height_attr', true, $image, $context, $attachment_id ); 2270 2271 if ( true === $add ) { 2272 $image_meta = wp_get_attachment_metadata( $attachment_id ); 2273 $size_array = wp_image_src_get_dimensions( $image_src, $image_meta, $attachment_id ); 2274 2275 if ( $size_array && $size_array[0] && $size_array[1] ) { 2276 // If the width is enforced through style (e.g. in an inline image), calculate the dimension attributes. 2277 $style_width = preg_match( '/style="width:\s*(\d+)px;"/', $image, $match_width ) ? (int) $match_width[1] : 0; 2278 if ( $style_width ) { 2279 $size_array[1] = (int) round( $size_array[1] * $style_width / $size_array[0] ); 2280 $size_array[0] = $style_width; 2281 } 2282 2283 $hw = trim( image_hwstring( $size_array[0], $size_array[1] ) ); 2284 return str_replace( '<img', "<img {$hw}", $image ); 2285 } 2286 } 2287 2288 return $image; 2289 } 2290 2291 /** 2292 * Adds `srcset` and `sizes` attributes to an existing `img` HTML tag. 2293 * 2294 * @since 5.5.0 2295 * 2296 * @param string $image The HTML `img` tag where the attribute should be added. 2297 * @param string $context Additional context to pass to the filters. 2298 * @param int $attachment_id Image attachment ID. 2299 * @return string Converted 'img' element with 'loading' attribute added. 2300 */ 2301 function wp_img_tag_add_srcset_and_sizes_attr( $image, $context, $attachment_id ) { 2302 /** 2303 * Filters whether to add the `srcset` and `sizes` HTML attributes to the img tag. Default `true`. 2304 * 2305 * Returning anything else than `true` will not add the attributes. 2306 * 2307 * @since 5.5.0 2308 * 2309 * @param bool $value The filtered value, defaults to `true`. 2310 * @param string $image The HTML `img` tag where the attribute should be added. 2311 * @param string $context Additional context about how the function was called or where the img tag is. 2312 * @param int $attachment_id The image attachment ID. 2313 */ 2314 $add = apply_filters( 'wp_img_tag_add_srcset_and_sizes_attr', true, $image, $context, $attachment_id ); 2315 2316 if ( true === $add ) { 2317 $image_meta = wp_get_attachment_metadata( $attachment_id ); 2318 return wp_image_add_srcset_and_sizes( $image, $image_meta, $attachment_id ); 2319 } 2320 2321 return $image; 2322 } 2323 2324 /** 2325 * Adds `loading` attribute to an `iframe` HTML tag. 2326 * 2327 * @since 5.7.0 2328 * 2329 * @param string $iframe The HTML `iframe` tag where the attribute should be added. 2330 * @param string $context Additional context to pass to the filters. 2331 * @return string Converted `iframe` tag with `loading` attribute added. 2332 */ 2333 function wp_iframe_tag_add_loading_attr( $iframe, $context ) { 2334 /* 2335 * Get loading attribute value to use. This must occur before the conditional check below so that even iframes that 2336 * are ineligible for being lazy-loaded are considered. 2337 */ 2338 $optimization_attrs = wp_get_loading_optimization_attributes( 2339 'iframe', 2340 array( 2341 /* 2342 * The concrete values for width and height are not important here for now 2343 * since fetchpriority is not yet supported for iframes. 2344 * TODO: Use WP_HTML_Tag_Processor to extract actual values once support is 2345 * added. 2346 */ 2347 'width' => str_contains( $iframe, ' width="' ) ? 100 : null, 2348 'height' => str_contains( $iframe, ' height="' ) ? 100 : null, 2349 // This function is never called when a 'loading' attribute is already present. 2350 'loading' => null, 2351 ), 2352 $context 2353 ); 2354 2355 // Iframes should have source and dimension attributes for the `loading` attribute to be added. 2356 if ( ! str_contains( $iframe, ' src="' ) || ! str_contains( $iframe, ' width="' ) || ! str_contains( $iframe, ' height="' ) ) { 2357 return $iframe; 2358 } 2359 2360 $value = isset( $optimization_attrs['loading'] ) ? $optimization_attrs['loading'] : false; 2361 2362 /** 2363 * Filters the `loading` attribute value to add to an iframe. Default `lazy`. 2364 * 2365 * Returning `false` or an empty string will not add the attribute. 2366 * Returning `true` will add the default value. 2367 * 2368 * @since 5.7.0 2369 * 2370 * @param string|bool $value The `loading` attribute value. Returning a falsey value will result in 2371 * the attribute being omitted for the iframe. 2372 * @param string $iframe The HTML `iframe` tag to be filtered. 2373 * @param string $context Additional context about how the function was called or where the iframe tag is. 2374 */ 2375 $value = apply_filters( 'wp_iframe_tag_add_loading_attr', $value, $iframe, $context ); 2376 2377 if ( $value ) { 2378 if ( ! in_array( $value, array( 'lazy', 'eager' ), true ) ) { 2379 $value = 'lazy'; 2380 } 2381 2382 return str_replace( '<iframe', '<iframe loading="' . esc_attr( $value ) . '"', $iframe ); 2383 } 2384 2385 return $iframe; 2386 } 2387 2388 /** 2389 * Adds a 'wp-post-image' class to post thumbnails. Internal use only. 2390 * 2391 * Uses the {@see 'begin_fetch_post_thumbnail_html'} and {@see 'end_fetch_post_thumbnail_html'} 2392 * action hooks to dynamically add/remove itself so as to only filter post thumbnails. 2393 * 2394 * @ignore 2395 * @since 2.9.0 2396 * 2397 * @param string[] $attr Array of thumbnail attributes including src, class, alt, title, keyed by attribute name. 2398 * @return string[] Modified array of attributes including the new 'wp-post-image' class. 2399 */ 2400 function _wp_post_thumbnail_class_filter( $attr ) { 2401 $attr['class'] .= ' wp-post-image'; 2402 return $attr; 2403 } 2404 2405 /** 2406 * Adds '_wp_post_thumbnail_class_filter' callback to the 'wp_get_attachment_image_attributes' 2407 * filter hook. Internal use only. 2408 * 2409 * @ignore 2410 * @since 2.9.0 2411 * 2412 * @param string[] $attr Array of thumbnail attributes including src, class, alt, title, keyed by attribute name. 2413 */ 2414 function _wp_post_thumbnail_class_filter_add( $attr ) { 2415 add_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' ); 2416 } 2417 2418 /** 2419 * Removes the '_wp_post_thumbnail_class_filter' callback from the 'wp_get_attachment_image_attributes' 2420 * filter hook. Internal use only. 2421 * 2422 * @ignore 2423 * @since 2.9.0 2424 * 2425 * @param string[] $attr Array of thumbnail attributes including src, class, alt, title, keyed by attribute name. 2426 */ 2427 function _wp_post_thumbnail_class_filter_remove( $attr ) { 2428 remove_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' ); 2429 } 2430 2431 /** 2432 * Overrides the context used in {@see wp_get_attachment_image()}. Internal use only. 2433 * 2434 * Uses the {@see 'begin_fetch_post_thumbnail_html'} and {@see 'end_fetch_post_thumbnail_html'} 2435 * action hooks to dynamically add/remove itself so as to only filter post thumbnails. 2436 * 2437 * @ignore 2438 * @since 6.3.0 2439 * @access private 2440 * 2441 * @param string $context The context for rendering an attachment image. 2442 * @return string Modified context set to 'the_post_thumbnail'. 2443 */ 2444 function _wp_post_thumbnail_context_filter( $context ) { 2445 return 'the_post_thumbnail'; 2446 } 2447 2448 /** 2449 * Adds the '_wp_post_thumbnail_context_filter' callback to the 'wp_get_attachment_image_context' 2450 * filter hook. Internal use only. 2451 * 2452 * @ignore 2453 * @since 6.3.0 2454 * @access private 2455 */ 2456 function _wp_post_thumbnail_context_filter_add() { 2457 add_filter( 'wp_get_attachment_image_context', '_wp_post_thumbnail_context_filter' ); 2458 } 2459 2460 /** 2461 * Removes the '_wp_post_thumbnail_context_filter' callback from the 'wp_get_attachment_image_context' 2462 * filter hook. Internal use only. 2463 * 2464 * @ignore 2465 * @since 6.3.0 2466 * @access private 2467 */ 2468 function _wp_post_thumbnail_context_filter_remove() { 2469 remove_filter( 'wp_get_attachment_image_context', '_wp_post_thumbnail_context_filter' ); 2470 } 2471 2472 add_shortcode( 'wp_caption', 'img_caption_shortcode' ); 2473 add_shortcode( 'caption', 'img_caption_shortcode' ); 2474 2475 /** 2476 * Builds the Caption shortcode output. 2477 * 2478 * Allows a plugin to replace the content that would otherwise be returned. The 2479 * filter is {@see 'img_caption_shortcode'} and passes an empty string, the attr 2480 * parameter and the content parameter values. 2481 * 2482 * The supported attributes for the shortcode are 'id', 'caption_id', 'align', 2483 * 'width', 'caption', and 'class'. 2484 * 2485 * @since 2.6.0 2486 * @since 3.9.0 The `class` attribute was added. 2487 * @since 5.1.0 The `caption_id` attribute was added. 2488 * @since 5.9.0 The `$content` parameter default value changed from `null` to `''`. 2489 * 2490 * @param array $attr { 2491 * Attributes of the caption shortcode. 2492 * 2493 * @type string $id ID of the image and caption container element, i.e. `<figure>` or `<div>`. 2494 * @type string $caption_id ID of the caption element, i.e. `<figcaption>` or `<p>`. 2495 * @type string $align Class name that aligns the caption. Default 'alignnone'. Accepts 'alignleft', 2496 * 'aligncenter', alignright', 'alignnone'. 2497 * @type int $width The width of the caption, in pixels. 2498 * @type string $caption The caption text. 2499 * @type string $class Additional class name(s) added to the caption container. 2500 * } 2501 * @param string $content Optional. Shortcode content. Default empty string. 2502 * @return string HTML content to display the caption. 2503 */ 2504 function img_caption_shortcode( $attr, $content = '' ) { 2505 // New-style shortcode with the caption inside the shortcode with the link and image tags. 2506 if ( ! isset( $attr['caption'] ) ) { 2507 if ( preg_match( '#((?:<a [^>]+>\s*)?<img [^>]+>(?:\s*</a>)?)(.*)#is', $content, $matches ) ) { 2508 $content = $matches[1]; 2509 $attr['caption'] = trim( $matches[2] ); 2510 } 2511 } elseif ( str_contains( $attr['caption'], '<' ) ) { 2512 $attr['caption'] = wp_kses( $attr['caption'], 'post' ); 2513 } 2514 2515 /** 2516 * Filters the default caption shortcode output. 2517 * 2518 * If the filtered output isn't empty, it will be used instead of generating 2519 * the default caption template. 2520 * 2521 * @since 2.6.0 2522 * 2523 * @see img_caption_shortcode() 2524 * 2525 * @param string $output The caption output. Default empty. 2526 * @param array $attr Attributes of the caption shortcode. 2527 * @param string $content The image element, possibly wrapped in a hyperlink. 2528 */ 2529 $output = apply_filters( 'img_caption_shortcode', '', $attr, $content ); 2530 2531 if ( ! empty( $output ) ) { 2532 return $output; 2533 } 2534 2535 $atts = shortcode_atts( 2536 array( 2537 'id' => '', 2538 'caption_id' => '', 2539 'align' => 'alignnone', 2540 'width' => '', 2541 'caption' => '', 2542 'class' => '', 2543 ), 2544 $attr, 2545 'caption' 2546 ); 2547 2548 $atts['width'] = (int) $atts['width']; 2549 2550 if ( $atts['width'] < 1 || empty( $atts['caption'] ) ) { 2551 return $content; 2552 } 2553 2554 $id = ''; 2555 $caption_id = ''; 2556 $describedby = ''; 2557 2558 if ( $atts['id'] ) { 2559 $atts['id'] = sanitize_html_class( $atts['id'] ); 2560 $id = 'id="' . esc_attr( $atts['id'] ) . '" '; 2561 } 2562 2563 if ( $atts['caption_id'] ) { 2564 $atts['caption_id'] = sanitize_html_class( $atts['caption_id'] ); 2565 } elseif ( $atts['id'] ) { 2566 $atts['caption_id'] = 'caption-' . str_replace( '_', '-', $atts['id'] ); 2567 } 2568 2569 if ( $atts['caption_id'] ) { 2570 $caption_id = 'id="' . esc_attr( $atts['caption_id'] ) . '" '; 2571 $describedby = 'aria-describedby="' . esc_attr( $atts['caption_id'] ) . '" '; 2572 } 2573 2574 $class = trim( 'wp-caption ' . $atts['align'] . ' ' . $atts['class'] ); 2575 2576 $html5 = current_theme_supports( 'html5', 'caption' ); 2577 // HTML5 captions never added the extra 10px to the image width. 2578 $width = $html5 ? $atts['width'] : ( 10 + $atts['width'] ); 2579 2580 /** 2581 * Filters the width of an image's caption. 2582 * 2583 * By default, the caption is 10 pixels greater than the width of the image, 2584 * to prevent post content from running up against a floated image. 2585 * 2586 * @since 3.7.0 2587 * 2588 * @see img_caption_shortcode() 2589 * 2590 * @param int $width Width of the caption in pixels. To remove this inline style, 2591 * return zero. 2592 * @param array $atts Attributes of the caption shortcode. 2593 * @param string $content The image element, possibly wrapped in a hyperlink. 2594 */ 2595 $caption_width = apply_filters( 'img_caption_shortcode_width', $width, $atts, $content ); 2596 2597 $style = ''; 2598 2599 if ( $caption_width ) { 2600 $style = 'style="width: ' . (int) $caption_width . 'px" '; 2601 } 2602 2603 if ( $html5 ) { 2604 $html = sprintf( 2605 '<figure %s%s%sclass="%s">%s%s</figure>', 2606 $id, 2607 $describedby, 2608 $style, 2609 esc_attr( $class ), 2610 do_shortcode( $content ), 2611 sprintf( 2612 '<figcaption %sclass="wp-caption-text">%s</figcaption>', 2613 $caption_id, 2614 $atts['caption'] 2615 ) 2616 ); 2617 } else { 2618 $html = sprintf( 2619 '<div %s%sclass="%s">%s%s</div>', 2620 $id, 2621 $style, 2622 esc_attr( $class ), 2623 str_replace( '<img ', '<img ' . $describedby, do_shortcode( $content ) ), 2624 sprintf( 2625 '<p %sclass="wp-caption-text">%s</p>', 2626 $caption_id, 2627 $atts['caption'] 2628 ) 2629 ); 2630 } 2631 2632 return $html; 2633 } 2634 2635 add_shortcode( 'gallery', 'gallery_shortcode' ); 2636 2637 /** 2638 * Builds the Gallery shortcode output. 2639 * 2640 * This implements the functionality of the Gallery Shortcode for displaying 2641 * WordPress images on a post. 2642 * 2643 * @since 2.5.0 2644 * @since 2.8.0 Added the `$attr` parameter to set the shortcode output. New attributes included 2645 * such as `size`, `itemtag`, `icontag`, `captiontag`, and columns. Changed markup from 2646 * `div` tags to `dl`, `dt` and `dd` tags. Support more than one gallery on the 2647 * same page. 2648 * @since 2.9.0 Added support for `include` and `exclude` to shortcode. 2649 * @since 3.5.0 Use get_post() instead of global `$post`. Handle mapping of `ids` to `include` 2650 * and `orderby`. 2651 * @since 3.6.0 Added validation for tags used in gallery shortcode. Add orientation information to items. 2652 * @since 3.7.0 Introduced the `link` attribute. 2653 * @since 3.9.0 `html5` gallery support, accepting 'itemtag', 'icontag', and 'captiontag' attributes. 2654 * @since 4.0.0 Removed use of `extract()`. 2655 * @since 4.1.0 Added attribute to `wp_get_attachment_link()` to output `aria-describedby`. 2656 * @since 4.2.0 Passed the shortcode instance ID to `post_gallery` and `post_playlist` filters. 2657 * @since 4.6.0 Standardized filter docs to match documentation standards for PHP. 2658 * @since 5.1.0 Code cleanup for WPCS 1.0.0 coding standards. 2659 * @since 5.3.0 Saved progress of intermediate image creation after upload. 2660 * @since 5.5.0 Ensured that galleries can be output as a list of links in feeds. 2661 * @since 5.6.0 Replaced order-style PHP type conversion functions with typecasts. Fix logic for 2662 * an array of image dimensions. 2663 * 2664 * @param array $attr { 2665 * Attributes of the gallery shortcode. 2666 * 2667 * @type string $order Order of the images in the gallery. Default 'ASC'. Accepts 'ASC', 'DESC'. 2668 * @type string $orderby The field to use when ordering the images. Default 'menu_order ID'. 2669 * Accepts any valid SQL ORDERBY statement. 2670 * @type int $id Post ID. 2671 * @type string $itemtag HTML tag to use for each image in the gallery. 2672 * Default 'dl', or 'figure' when the theme registers HTML5 gallery support. 2673 * @type string $icontag HTML tag to use for each image's icon. 2674 * Default 'dt', or 'div' when the theme registers HTML5 gallery support. 2675 * @type string $captiontag HTML tag to use for each image's caption. 2676 * Default 'dd', or 'figcaption' when the theme registers HTML5 gallery support. 2677 * @type int $columns Number of columns of images to display. Default 3. 2678 * @type string|int[] $size Size of the images to display. Accepts any registered image size name, or an array 2679 * of width and height values in pixels (in that order). Default 'thumbnail'. 2680 * @type string $ids A comma-separated list of IDs of attachments to display. Default empty. 2681 * @type string $include A comma-separated list of IDs of attachments to include. Default empty. 2682 * @type string $exclude A comma-separated list of IDs of attachments to exclude. Default empty. 2683 * @type string $link What to link each image to. Default empty (links to the attachment page). 2684 * Accepts 'file', 'none'. 2685 * } 2686 * @return string HTML content to display gallery. 2687 */ 2688 function gallery_shortcode( $attr ) { 2689 $post = get_post(); 2690 2691 static $instance = 0; 2692 ++$instance; 2693 2694 if ( ! empty( $attr['ids'] ) ) { 2695 // 'ids' is explicitly ordered, unless you specify otherwise. 2696 if ( empty( $attr['orderby'] ) ) { 2697 $attr['orderby'] = 'post__in'; 2698 } 2699 $attr['include'] = $attr['ids']; 2700 } 2701 2702 /** 2703 * Filters the default gallery shortcode output. 2704 * 2705 * If the filtered output isn't empty, it will be used instead of generating 2706 * the default gallery template. 2707 * 2708 * @since 2.5.0 2709 * @since 4.2.0 The `$instance` parameter was added. 2710 * 2711 * @see gallery_shortcode() 2712 * 2713 * @param string $output The gallery output. Default empty. 2714 * @param array $attr Attributes of the gallery shortcode. 2715 * @param int $instance Unique numeric ID of this gallery shortcode instance. 2716 */ 2717 $output = apply_filters( 'post_gallery', '', $attr, $instance ); 2718 2719 if ( ! empty( $output ) ) { 2720 return $output; 2721 } 2722 2723 $html5 = current_theme_supports( 'html5', 'gallery' ); 2724 $atts = shortcode_atts( 2725 array( 2726 'order' => 'ASC', 2727 'orderby' => 'menu_order ID', 2728 'id' => $post ? $post->ID : 0, 2729 'itemtag' => $html5 ? 'figure' : 'dl', 2730 'icontag' => $html5 ? 'div' : 'dt', 2731 'captiontag' => $html5 ? 'figcaption' : 'dd', 2732 'columns' => 3, 2733 'size' => 'thumbnail', 2734 'include' => '', 2735 'exclude' => '', 2736 'link' => '', 2737 ), 2738 $attr, 2739 'gallery' 2740 ); 2741 2742 $id = (int) $atts['id']; 2743 2744 if ( ! empty( $atts['include'] ) ) { 2745 $_attachments = get_posts( 2746 array( 2747 'include' => $atts['include'], 2748 'post_status' => 'inherit', 2749 'post_type' => 'attachment', 2750 'post_mime_type' => 'image', 2751 'order' => $atts['order'], 2752 'orderby' => $atts['orderby'], 2753 ) 2754 ); 2755 2756 $attachments = array(); 2757 foreach ( $_attachments as $key => $val ) { 2758 $attachments[ $val->ID ] = $_attachments[ $key ]; 2759 } 2760 } elseif ( ! empty( $atts['exclude'] ) ) { 2761 $post_parent_id = $id; 2762 $attachments = get_children( 2763 array( 2764 'post_parent' => $id, 2765 'exclude' => $atts['exclude'], 2766 'post_status' => 'inherit', 2767 'post_type' => 'attachment', 2768 'post_mime_type' => 'image', 2769 'order' => $atts['order'], 2770 'orderby' => $atts['orderby'], 2771 ) 2772 ); 2773 } else { 2774 $post_parent_id = $id; 2775 $attachments = get_children( 2776 array( 2777 'post_parent' => $id, 2778 'post_status' => 'inherit', 2779 'post_type' => 'attachment', 2780 'post_mime_type' => 'image', 2781 'order' => $atts['order'], 2782 'orderby' => $atts['orderby'], 2783 ) 2784 ); 2785 } 2786 2787 if ( ! empty( $post_parent_id ) ) { 2788 $post_parent = get_post( $post_parent_id ); 2789 2790 // Terminate the shortcode execution if the user cannot read the post or it is password-protected. 2791 if ( ! is_post_publicly_viewable( $post_parent->ID ) && ! current_user_can( 'read_post', $post_parent->ID ) 2792 || post_password_required( $post_parent ) 2793 ) { 2794 return ''; 2795 } 2796 } 2797 2798 if ( empty( $attachments ) ) { 2799 return ''; 2800 } 2801 2802 if ( is_feed() ) { 2803 $output = "\n"; 2804 foreach ( $attachments as $att_id => $attachment ) { 2805 if ( ! empty( $atts['link'] ) ) { 2806 if ( 'none' === $atts['link'] ) { 2807 $output .= wp_get_attachment_image( $att_id, $atts['size'], false, $attr ); 2808 } else { 2809 $output .= wp_get_attachment_link( $att_id, $atts['size'], false ); 2810 } 2811 } else { 2812 $output .= wp_get_attachment_link( $att_id, $atts['size'], true ); 2813 } 2814 $output .= "\n"; 2815 } 2816 return $output; 2817 } 2818 2819 $itemtag = tag_escape( $atts['itemtag'] ); 2820 $captiontag = tag_escape( $atts['captiontag'] ); 2821 $icontag = tag_escape( $atts['icontag'] ); 2822 $valid_tags = wp_kses_allowed_html( 'post' ); 2823 if ( ! isset( $valid_tags[ $itemtag ] ) ) { 2824 $itemtag = 'dl'; 2825 } 2826 if ( ! isset( $valid_tags[ $captiontag ] ) ) { 2827 $captiontag = 'dd'; 2828 } 2829 if ( ! isset( $valid_tags[ $icontag ] ) ) { 2830 $icontag = 'dt'; 2831 } 2832 2833 $columns = (int) $atts['columns']; 2834 $itemwidth = $columns > 0 ? floor( 100 / $columns ) : 100; 2835 $float = is_rtl() ? 'right' : 'left'; 2836 2837 $selector = "gallery-{$instance}"; 2838 2839 $gallery_style = ''; 2840 2841 /** 2842 * Filters whether to print default gallery styles. 2843 * 2844 * @since 3.1.0 2845 * 2846 * @param bool $print Whether to print default gallery styles. 2847 * Defaults to false if the theme supports HTML5 galleries. 2848 * Otherwise, defaults to true. 2849 */ 2850 if ( apply_filters( 'use_default_gallery_style', ! $html5 ) ) { 2851 $type_attr = current_theme_supports( 'html5', 'style' ) ? '' : ' type="text/css"'; 2852 2853 $gallery_style = " 2854 <style{$type_attr}> 2855 #{$selector} { 2856 margin: auto; 2857 } 2858 #{$selector} .gallery-item { 2859 float: {$float}; 2860 margin-top: 10px; 2861 text-align: center; 2862 width: {$itemwidth}%; 2863 } 2864 #{$selector} img { 2865 border: 2px solid #cfcfcf; 2866 } 2867 #{$selector} .gallery-caption { 2868 margin-left: 0; 2869 } 2870 /* see gallery_shortcode() in wp-includes/media.php */ 2871 </style>\n\t\t"; 2872 } 2873 2874 $size_class = sanitize_html_class( is_array( $atts['size'] ) ? implode( 'x', $atts['size'] ) : $atts['size'] ); 2875 $gallery_div = "<div id='$selector' class='gallery galleryid-{$id} gallery-columns-{$columns} gallery-size-{$size_class}'>"; 2876 2877 /** 2878 * Filters the default gallery shortcode CSS styles. 2879 * 2880 * @since 2.5.0 2881 * 2882 * @param string $gallery_style Default CSS styles and opening HTML div container 2883 * for the gallery shortcode output. 2884 */ 2885 $output = apply_filters( 'gallery_style', $gallery_style . $gallery_div ); 2886 2887 $i = 0; 2888 2889 foreach ( $attachments as $id => $attachment ) { 2890 2891 $attr = ( trim( $attachment->post_excerpt ) ) ? array( 'aria-describedby' => "$selector-$id" ) : ''; 2892 2893 if ( ! empty( $atts['link'] ) && 'file' === $atts['link'] ) { 2894 $image_output = wp_get_attachment_link( $id, $atts['size'], false, false, false, $attr ); 2895 } elseif ( ! empty( $atts['link'] ) && 'none' === $atts['link'] ) { 2896 $image_output = wp_get_attachment_image( $id, $atts['size'], false, $attr ); 2897 } else { 2898 $image_output = wp_get_attachment_link( $id, $atts['size'], true, false, false, $attr ); 2899 } 2900 2901 $image_meta = wp_get_attachment_metadata( $id ); 2902 2903 $orientation = ''; 2904 2905 if ( isset( $image_meta['height'], $image_meta['width'] ) ) { 2906 $orientation = ( $image_meta['height'] > $image_meta['width'] ) ? 'portrait' : 'landscape'; 2907 } 2908 2909 $output .= "<{$itemtag} class='gallery-item'>"; 2910 $output .= " 2911 <{$icontag} class='gallery-icon {$orientation}'> 2912 $image_output 2913 </{$icontag}>"; 2914 2915 if ( $captiontag && trim( $attachment->post_excerpt ) ) { 2916 $output .= " 2917 <{$captiontag} class='wp-caption-text gallery-caption' id='$selector-$id'> 2918 " . wptexturize( $attachment->post_excerpt ) . " 2919 </{$captiontag}>"; 2920 } 2921 2922 $output .= "</{$itemtag}>"; 2923 2924 if ( ! $html5 && $columns > 0 && 0 === ++$i % $columns ) { 2925 $output .= '<br style="clear: both" />'; 2926 } 2927 } 2928 2929 if ( ! $html5 && $columns > 0 && 0 !== $i % $columns ) { 2930 $output .= " 2931 <br style='clear: both' />"; 2932 } 2933 2934 $output .= " 2935 </div>\n"; 2936 2937 return $output; 2938 } 2939 2940 /** 2941 * Outputs the templates used by playlists. 2942 * 2943 * @since 3.9.0 2944 */ 2945 function wp_underscore_playlist_templates() { 2946 ?> 2947 <script type="text/html" id="tmpl-wp-playlist-current-item"> 2948 <# if ( data.thumb && data.thumb.src ) { #> 2949 <img src="{{ data.thumb.src }}" alt="" /> 2950 <# } #> 2951 <div class="wp-playlist-caption"> 2952 <span class="wp-playlist-item-meta wp-playlist-item-title"> 2953 <# if ( data.meta.album || data.meta.artist ) { #> 2954 <?php 2955 /* translators: %s: Playlist item title. */ 2956 printf( _x( '“%s”', 'playlist item title' ), '{{ data.title }}' ); 2957 ?> 2958 <# } else { #> 2959 {{ data.title }} 2960 <# } #> 2961 </span> 2962 <# if ( data.meta.album ) { #><span class="wp-playlist-item-meta wp-playlist-item-album">{{ data.meta.album }}</span><# } #> 2963 <# if ( data.meta.artist ) { #><span class="wp-playlist-item-meta wp-playlist-item-artist">{{ data.meta.artist }}</span><# } #> 2964 </div> 2965 </script> 2966 <script type="text/html" id="tmpl-wp-playlist-item"> 2967 <div class="wp-playlist-item"> 2968 <a class="wp-playlist-caption" href="{{ data.src }}"> 2969 {{ data.index ? ( data.index + '. ' ) : '' }} 2970 <# if ( data.caption ) { #> 2971 {{ data.caption }} 2972 <# } else { #> 2973 <# if ( data.artists && data.meta.artist ) { #> 2974 <span class="wp-playlist-item-title"> 2975 <?php 2976 /* translators: %s: Playlist item title. */ 2977 printf( _x( '“%s”', 'playlist item title' ), '{{{ data.title }}}' ); 2978 ?> 2979 </span> 2980 <span class="wp-playlist-item-artist"> — {{ data.meta.artist }}</span> 2981 <# } else { #> 2982 <span class="wp-playlist-item-title">{{{ data.title }}}</span> 2983 <# } #> 2984 <# } #> 2985 </a> 2986 <# if ( data.meta.length_formatted ) { #> 2987 <div class="wp-playlist-item-length">{{ data.meta.length_formatted }}</div> 2988 <# } #> 2989 </div> 2990 </script> 2991 <?php 2992 } 2993 2994 /** 2995 * Outputs and enqueues default scripts and styles for playlists. 2996 * 2997 * @since 3.9.0 2998 * 2999 * @param string $type Type of playlist. Accepts 'audio' or 'video'. 3000 */ 3001 function wp_playlist_scripts( $type ) { 3002 wp_enqueue_style( 'wp-mediaelement' ); 3003 wp_enqueue_script( 'wp-playlist' ); 3004 add_action( 'wp_footer', 'wp_underscore_playlist_templates', 0 ); 3005 add_action( 'admin_footer', 'wp_underscore_playlist_templates', 0 ); 3006 } 3007 3008 /** 3009 * Builds the Playlist shortcode output. 3010 * 3011 * This implements the functionality of the playlist shortcode for displaying 3012 * a collection of WordPress audio or video files in a post. 3013 * 3014 * @since 3.9.0 3015 * 3016 * @global int $content_width 3017 * 3018 * @param array $attr { 3019 * Array of default playlist attributes. 3020 * 3021 * @type string $type Type of playlist to display. Accepts 'audio' or 'video'. Default 'audio'. 3022 * @type string $order Designates ascending or descending order of items in the playlist. 3023 * Accepts 'ASC', 'DESC'. Default 'ASC'. 3024 * @type string $orderby Any column, or columns, to sort the playlist. If $ids are 3025 * passed, this defaults to the order of the $ids array ('post__in'). 3026 * Otherwise default is 'menu_order ID'. 3027 * @type int $id If an explicit $ids array is not present, this parameter 3028 * will determine which attachments are used for the playlist. 3029 * Default is the current post ID. 3030 * @type array $ids Create a playlist out of these explicit attachment IDs. If empty, 3031 * a playlist will be created from all $type attachments of $id. 3032 * Default empty. 3033 * @type array $exclude List of specific attachment IDs to exclude from the playlist. Default empty. 3034 * @type string $style Playlist style to use. Accepts 'light' or 'dark'. Default 'light'. 3035 * @type bool $tracklist Whether to show or hide the playlist. Default true. 3036 * @type bool $tracknumbers Whether to show or hide the numbers next to entries in the playlist. Default true. 3037 * @type bool $images Show or hide the video or audio thumbnail (Featured Image/post 3038 * thumbnail). Default true. 3039 * @type bool $artists Whether to show or hide artist name in the playlist. Default true. 3040 * } 3041 * 3042 * @return string Playlist output. Empty string if the passed type is unsupported. 3043 */ 3044 function wp_playlist_shortcode( $attr ) { 3045 global $content_width; 3046 $post = get_post(); 3047 3048 static $instance = 0; 3049 ++$instance; 3050 3051 if ( ! empty( $attr['ids'] ) ) { 3052 // 'ids' is explicitly ordered, unless you specify otherwise. 3053 if ( empty( $attr['orderby'] ) ) { 3054 $attr['orderby'] = 'post__in'; 3055 } 3056 $attr['include'] = $attr['ids']; 3057 } 3058 3059 /** 3060 * Filters the playlist output. 3061 * 3062 * Returning a non-empty value from the filter will short-circuit generation 3063 * of the default playlist output, returning the passed value instead. 3064 * 3065 * @since 3.9.0 3066 * @since 4.2.0 The `$instance` parameter was added. 3067 * 3068 * @param string $output Playlist output. Default empty. 3069 * @param array $attr An array of shortcode attributes. 3070 * @param int $instance Unique numeric ID of this playlist shortcode instance. 3071 */ 3072 $output = apply_filters( 'post_playlist', '', $attr, $instance ); 3073 3074 if ( ! empty( $output ) ) { 3075 return $output; 3076 } 3077 3078 $atts = shortcode_atts( 3079 array( 3080 'type' => 'audio', 3081 'order' => 'ASC', 3082 'orderby' => 'menu_order ID', 3083 'id' => $post ? $post->ID : 0, 3084 'include' => '', 3085 'exclude' => '', 3086 'style' => 'light', 3087 'tracklist' => true, 3088 'tracknumbers' => true, 3089 'images' => true, 3090 'artists' => true, 3091 ), 3092 $attr, 3093 'playlist' 3094 ); 3095 3096 $id = (int) $atts['id']; 3097 3098 if ( 'audio' !== $atts['type'] ) { 3099 $atts['type'] = 'video'; 3100 } 3101 3102 $args = array( 3103 'post_status' => 'inherit', 3104 'post_type' => 'attachment', 3105 'post_mime_type' => $atts['type'], 3106 'order' => $atts['order'], 3107 'orderby' => $atts['orderby'], 3108 ); 3109 3110 if ( ! empty( $atts['include'] ) ) { 3111 $args['include'] = $atts['include']; 3112 $_attachments = get_posts( $args ); 3113 3114 $attachments = array(); 3115 foreach ( $_attachments as $key => $val ) { 3116 $attachments[ $val->ID ] = $_attachments[ $key ]; 3117 } 3118 } elseif ( ! empty( $atts['exclude'] ) ) { 3119 $args['post_parent'] = $id; 3120 $args['exclude'] = $atts['exclude']; 3121 $attachments = get_children( $args ); 3122 } else { 3123 $args['post_parent'] = $id; 3124 $attachments = get_children( $args ); 3125 } 3126 3127 if ( ! empty( $args['post_parent'] ) ) { 3128 $post_parent = get_post( $id ); 3129 3130 // Terminate the shortcode execution if the user cannot read the post or it is password-protected. 3131 if ( ! current_user_can( 'read_post', $post_parent->ID ) || post_password_required( $post_parent ) ) { 3132 return ''; 3133 } 3134 } 3135 3136 if ( empty( $attachments ) ) { 3137 return ''; 3138 } 3139 3140 if ( is_feed() ) { 3141 $output = "\n"; 3142 foreach ( $attachments as $att_id => $attachment ) { 3143 $output .= wp_get_attachment_link( $att_id ) . "\n"; 3144 } 3145 return $output; 3146 } 3147 3148 $outer = 22; // Default padding and border of wrapper. 3149 3150 $default_width = 640; 3151 $default_height = 360; 3152 3153 $theme_width = empty( $content_width ) ? $default_width : ( $content_width - $outer ); 3154 $theme_height = empty( $content_width ) ? $default_height : round( ( $default_height * $theme_width ) / $default_width ); 3155 3156 $data = array( 3157 'type' => $atts['type'], 3158 // Don't pass strings to JSON, will be truthy in JS. 3159 'tracklist' => wp_validate_boolean( $atts['tracklist'] ), 3160 'tracknumbers' => wp_validate_boolean( $atts['tracknumbers'] ), 3161 'images' => wp_validate_boolean( $atts['images'] ), 3162 'artists' => wp_validate_boolean( $atts['artists'] ), 3163 ); 3164 3165 $tracks = array(); 3166 foreach ( $attachments as $attachment ) { 3167 $url = wp_get_attachment_url( $attachment->ID ); 3168 $ftype = wp_check_filetype( $url, wp_get_mime_types() ); 3169 $track = array( 3170 'src' => $url, 3171 'type' => $ftype['type'], 3172 'title' => $attachment->post_title, 3173 'caption' => $attachment->post_excerpt, 3174 'description' => $attachment->post_content, 3175 ); 3176 3177 $track['meta'] = array(); 3178 $meta = wp_get_attachment_metadata( $attachment->ID ); 3179 if ( ! empty( $meta ) ) { 3180 3181 foreach ( wp_get_attachment_id3_keys( $attachment ) as $key => $label ) { 3182 if ( ! empty( $meta[ $key ] ) ) { 3183 $track['meta'][ $key ] = $meta[ $key ]; 3184 } 3185 } 3186 3187 if ( 'video' === $atts['type'] ) { 3188 if ( ! empty( $meta['width'] ) && ! empty( $meta['height'] ) ) { 3189 $width = $meta['width']; 3190 $height = $meta['height']; 3191 $theme_height = round( ( $height * $theme_width ) / $width ); 3192 } else { 3193 $width = $default_width; 3194 $height = $default_height; 3195 } 3196 3197 $track['dimensions'] = array( 3198 'original' => compact( 'width', 'height' ), 3199 'resized' => array( 3200 'width' => $theme_width, 3201 'height' => $theme_height, 3202 ), 3203 ); 3204 } 3205 } 3206 3207 if ( $atts['images'] ) { 3208 $thumb_id = get_post_thumbnail_id( $attachment->ID ); 3209 if ( ! empty( $thumb_id ) ) { 3210 list( $src, $width, $height ) = wp_get_attachment_image_src( $thumb_id, 'full' ); 3211 $track['image'] = compact( 'src', 'width', 'height' ); 3212 list( $src, $width, $height ) = wp_get_attachment_image_src( $thumb_id, 'thumbnail' ); 3213 $track['thumb'] = compact( 'src', 'width', 'height' ); 3214 } else { 3215 $src = wp_mime_type_icon( $attachment->ID, '.svg' ); 3216 $width = 48; 3217 $height = 64; 3218 $track['image'] = compact( 'src', 'width', 'height' ); 3219 $track['thumb'] = compact( 'src', 'width', 'height' ); 3220 } 3221 } 3222 3223 $tracks[] = $track; 3224 } 3225 $data['tracks'] = $tracks; 3226 3227 $safe_type = esc_attr( $atts['type'] ); 3228 $safe_style = esc_attr( $atts['style'] ); 3229 3230 ob_start(); 3231 3232 if ( 1 === $instance ) { 3233 /** 3234 * Prints and enqueues playlist scripts, styles, and JavaScript templates. 3235 * 3236 * @since 3.9.0 3237 * 3238 * @param string $type Type of playlist. Possible values are 'audio' or 'video'. 3239 * @param string $style The 'theme' for the playlist. Core provides 'light' and 'dark'. 3240 */ 3241 do_action( 'wp_playlist_scripts', $atts['type'], $atts['style'] ); 3242 } 3243 ?> 3244 <div class="wp-playlist wp-<?php echo $safe_type; ?>-playlist wp-playlist-<?php echo $safe_style; ?>"> 3245 <?php if ( 'audio' === $atts['type'] ) : ?> 3246 <div class="wp-playlist-current-item"></div> 3247 <?php endif; ?> 3248 <<?php echo $safe_type; ?> controls="controls" preload="none" width="<?php echo (int) $theme_width; ?>" 3249 <?php 3250 if ( 'video' === $safe_type ) { 3251 echo ' height="', (int) $theme_height, '"'; 3252 } 3253 ?> 3254 ></<?php echo $safe_type; ?>> 3255 <div class="wp-playlist-next"></div> 3256 <div class="wp-playlist-prev"></div> 3257 <noscript> 3258 <ol> 3259 <?php 3260 foreach ( $attachments as $att_id => $attachment ) { 3261 printf( '<li>%s</li>', wp_get_attachment_link( $att_id ) ); 3262 } 3263 ?> 3264 </ol> 3265 </noscript> 3266 <script type="application/json" class="wp-playlist-script"><?php echo wp_json_encode( $data ); ?></script> 3267 </div> 3268 <?php 3269 return ob_get_clean(); 3270 } 3271 add_shortcode( 'playlist', 'wp_playlist_shortcode' ); 3272 3273 /** 3274 * Provides a No-JS Flash fallback as a last resort for audio / video. 3275 * 3276 * @since 3.6.0 3277 * 3278 * @param string $url The media element URL. 3279 * @return string Fallback HTML. 3280 */ 3281 function wp_mediaelement_fallback( $url ) { 3282 /** 3283 * Filters the MediaElement fallback output for no-JS. 3284 * 3285 * @since 3.6.0 3286 * 3287 * @param string $output Fallback output for no-JS. 3288 * @param string $url Media file URL. 3289 */ 3290 return apply_filters( 'wp_mediaelement_fallback', sprintf( '<a href="%1$s">%1$s</a>', esc_url( $url ) ), $url ); 3291 } 3292 3293 /** 3294 * Returns a filtered list of supported audio formats. 3295 * 3296 * @since 3.6.0 3297 * 3298 * @return string[] Supported audio formats. 3299 */ 3300 function wp_get_audio_extensions() { 3301 /** 3302 * Filters the list of supported audio formats. 3303 * 3304 * @since 3.6.0 3305 * 3306 * @param string[] $extensions An array of supported audio formats. Defaults are 3307 * 'mp3', 'ogg', 'flac', 'm4a', 'wav'. 3308 */ 3309 return apply_filters( 'wp_audio_extensions', array( 'mp3', 'ogg', 'flac', 'm4a', 'wav' ) ); 3310 } 3311 3312 /** 3313 * Returns useful keys to use to lookup data from an attachment's stored metadata. 3314 * 3315 * @since 3.9.0 3316 * 3317 * @param WP_Post $attachment The current attachment, provided for context. 3318 * @param string $context Optional. The context. Accepts 'edit', 'display'. Default 'display'. 3319 * @return string[] Key/value pairs of field keys to labels. 3320 */ 3321 function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) { 3322 $fields = array( 3323 'artist' => __( 'Artist' ), 3324 'album' => __( 'Album' ), 3325 ); 3326 3327 if ( 'display' === $context ) { 3328 $fields['genre'] = __( 'Genre' ); 3329 $fields['year'] = __( 'Year' ); 3330 $fields['length_formatted'] = _x( 'Length', 'video or audio' ); 3331 } elseif ( 'js' === $context ) { 3332 $fields['bitrate'] = __( 'Bitrate' ); 3333 $fields['bitrate_mode'] = __( 'Bitrate Mode' ); 3334 } 3335 3336 /** 3337 * Filters the editable list of keys to look up data from an attachment's metadata. 3338 * 3339 * @since 3.9.0 3340 * 3341 * @param array $fields Key/value pairs of field keys to labels. 3342 * @param WP_Post $attachment Attachment object. 3343 * @param string $context The context. Accepts 'edit', 'display'. Default 'display'. 3344 */ 3345 return apply_filters( 'wp_get_attachment_id3_keys', $fields, $attachment, $context ); 3346 } 3347 /** 3348 * Builds the Audio shortcode output. 3349 * 3350 * This implements the functionality of the Audio Shortcode for displaying 3351 * WordPress mp3s in a post. 3352 * 3353 * @since 3.6.0 3354 * @since 6.8.0 Added the 'muted' attribute. 3355 * 3356 * @param array $attr { 3357 * Attributes of the audio shortcode. 3358 * 3359 * @type string $src URL to the source of the audio file. Default empty. 3360 * @type string $loop The 'loop' attribute for the `<audio>` element. Default empty. 3361 * @type string $autoplay The 'autoplay' attribute for the `<audio>` element. Default empty. 3362 * @type string $muted The 'muted' attribute for the `<audio>` element. Default 'false'. 3363 * @type string $preload The 'preload' attribute for the `<audio>` element. Default 'none'. 3364 * @type string $class The 'class' attribute for the `<audio>` element. Default 'wp-audio-shortcode'. 3365 * @type string $style The 'style' attribute for the `<audio>` element. Default 'width: 100%;'. 3366 * } 3367 * @param string $content Shortcode content. 3368 * @return string|void HTML content to display audio. 3369 */ 3370 function wp_audio_shortcode( $attr, $content = '' ) { 3371 $post_id = get_post() ? get_the_ID() : 0; 3372 3373 static $instance = 0; 3374 ++$instance; 3375 3376 /** 3377 * Filters the default audio shortcode output. 3378 * 3379 * If the filtered output isn't empty, it will be used instead of generating the default audio template. 3380 * 3381 * @since 3.6.0 3382 * 3383 * @param string $html Empty variable to be replaced with shortcode markup. 3384 * @param array $attr Attributes of the shortcode. See {@see wp_audio_shortcode()}. 3385 * @param string $content Shortcode content. 3386 * @param int $instance Unique numeric ID of this audio shortcode instance. 3387 */ 3388 $override = apply_filters( 'wp_audio_shortcode_override', '', $attr, $content, $instance ); 3389 3390 if ( '' !== $override ) { 3391 return $override; 3392 } 3393 3394 $audio = null; 3395 3396 $default_types = wp_get_audio_extensions(); 3397 $defaults_atts = array( 3398 'src' => '', 3399 'loop' => '', 3400 'autoplay' => '', 3401 'muted' => 'false', 3402 'preload' => 'none', 3403 'class' => 'wp-audio-shortcode', 3404 'style' => 'width: 100%;', 3405 ); 3406 foreach ( $default_types as $type ) { 3407 $defaults_atts[ $type ] = ''; 3408 } 3409 3410 $atts = shortcode_atts( $defaults_atts, $attr, 'audio' ); 3411 3412 $primary = false; 3413 if ( ! empty( $atts['src'] ) ) { 3414 $type = wp_check_filetype( $atts['src'], wp_get_mime_types() ); 3415 3416 if ( ! in_array( strtolower( $type['ext'] ), $default_types, true ) ) { 3417 return sprintf( '<a class="wp-embedded-audio" href="%s">%s</a>', esc_url( $atts['src'] ), esc_html( $atts['src'] ) ); 3418 } 3419 3420 $primary = true; 3421 array_unshift( $default_types, 'src' ); 3422 } else { 3423 foreach ( $default_types as $ext ) { 3424 if ( ! empty( $atts[ $ext ] ) ) { 3425 $type = wp_check_filetype( $atts[ $ext ], wp_get_mime_types() ); 3426 3427 if ( strtolower( $type['ext'] ) === $ext ) { 3428 $primary = true; 3429 } 3430 } 3431 } 3432 } 3433 3434 if ( ! $primary ) { 3435 $audios = get_attached_media( 'audio', $post_id ); 3436 3437 if ( empty( $audios ) ) { 3438 return; 3439 } 3440 3441 $audio = reset( $audios ); 3442 $atts['src'] = wp_get_attachment_url( $audio->ID ); 3443 3444 if ( empty( $atts['src'] ) ) { 3445 return; 3446 } 3447 3448 array_unshift( $default_types, 'src' ); 3449 } 3450 3451 /** 3452 * Filters the media library used for the audio shortcode. 3453 * 3454 * @since 3.6.0 3455 * 3456 * @param string $library Media library used for the audio shortcode. 3457 */ 3458 $library = apply_filters( 'wp_audio_shortcode_library', 'mediaelement' ); 3459 3460 if ( 'mediaelement' === $library && did_action( 'init' ) ) { 3461 wp_enqueue_style( 'wp-mediaelement' ); 3462 wp_enqueue_script( 'wp-mediaelement' ); 3463 } 3464 3465 /** 3466 * Filters the class attribute for the audio shortcode output container. 3467 * 3468 * @since 3.6.0 3469 * @since 4.9.0 The `$atts` parameter was added. 3470 * 3471 * @param string $class CSS class or list of space-separated classes. 3472 * @param array $atts Array of audio shortcode attributes. 3473 */ 3474 $atts['class'] = apply_filters( 'wp_audio_shortcode_class', $atts['class'], $atts ); 3475 3476 $html_atts = array( 3477 'class' => $atts['class'], 3478 'id' => sprintf( 'audio-%d-%d', $post_id, $instance ), 3479 'loop' => wp_validate_boolean( $atts['loop'] ), 3480 'autoplay' => wp_validate_boolean( $atts['autoplay'] ), 3481 'muted' => wp_validate_boolean( $atts['muted'] ), 3482 'preload' => $atts['preload'], 3483 'style' => $atts['style'], 3484 ); 3485 3486 // These ones should just be omitted altogether if they are blank. 3487 foreach ( array( 'loop', 'autoplay', 'preload', 'muted' ) as $a ) { 3488 if ( empty( $html_atts[ $a ] ) ) { 3489 unset( $html_atts[ $a ] ); 3490 } 3491 } 3492 3493 $attr_strings = array(); 3494 3495 foreach ( $html_atts as $attribute_name => $attribute_value ) { 3496 if ( in_array( $attribute_name, array( 'loop', 'autoplay', 'muted' ), true ) && true === $attribute_value ) { 3497 // Add boolean attributes without a value. 3498 $attr_strings[] = esc_attr( $attribute_name ); 3499 } elseif ( 'preload' === $attribute_name && ! empty( $attribute_value ) ) { 3500 // Handle the preload attribute with specific allowed values. 3501 $allowed_preload_values = array( 'none', 'metadata', 'auto' ); 3502 if ( in_array( $attribute_value, $allowed_preload_values, true ) ) { 3503 $attr_strings[] = sprintf( '%s="%s"', esc_attr( $attribute_name ), esc_attr( $attribute_value ) ); 3504 } 3505 } else { 3506 // For other attributes, include the value. 3507 $attr_strings[] = sprintf( '%s="%s"', esc_attr( $attribute_name ), esc_attr( $attribute_value ) ); 3508 } 3509 } 3510 3511 $html = sprintf( '<audio %s controls="controls">', implode( ' ', $attr_strings ) ); 3512 $fileurl = ''; 3513 $source = '<source type="%s" src="%s" />'; 3514 3515 foreach ( $default_types as $fallback ) { 3516 if ( ! empty( $atts[ $fallback ] ) ) { 3517 if ( empty( $fileurl ) ) { 3518 $fileurl = $atts[ $fallback ]; 3519 } 3520 3521 $type = wp_check_filetype( $atts[ $fallback ], wp_get_mime_types() ); 3522 $url = add_query_arg( '_', $instance, $atts[ $fallback ] ); 3523 $html .= sprintf( $source, $type['type'], esc_url( $url ) ); 3524 } 3525 } 3526 3527 if ( 'mediaelement' === $library ) { 3528 $html .= wp_mediaelement_fallback( $fileurl ); 3529 } 3530 3531 $html .= '</audio>'; 3532 3533 /** 3534 * Filters the audio shortcode output. 3535 * 3536 * @since 3.6.0 3537 * 3538 * @param string $html Audio shortcode HTML output. 3539 * @param array $atts Array of audio shortcode attributes. 3540 * @param string $audio Audio file. 3541 * @param int $post_id Post ID. 3542 * @param string $library Media library used for the audio shortcode. 3543 */ 3544 return apply_filters( 'wp_audio_shortcode', $html, $atts, $audio, $post_id, $library ); 3545 } 3546 add_shortcode( 'audio', 'wp_audio_shortcode' ); 3547 3548 /** 3549 * Returns a filtered list of supported video formats. 3550 * 3551 * @since 3.6.0 3552 * 3553 * @return string[] List of supported video formats. 3554 */ 3555 function wp_get_video_extensions() { 3556 /** 3557 * Filters the list of supported video formats. 3558 * 3559 * @since 3.6.0 3560 * 3561 * @param string[] $extensions An array of supported video formats. Defaults are 3562 * 'mp4', 'm4v', 'webm', 'ogv', 'flv'. 3563 */ 3564 return apply_filters( 'wp_video_extensions', array( 'mp4', 'm4v', 'webm', 'ogv', 'flv' ) ); 3565 } 3566 3567 /** 3568 * Builds the Video shortcode output. 3569 * 3570 * This implements the functionality of the Video Shortcode for displaying 3571 * WordPress mp4s in a post. 3572 * 3573 * @since 3.6.0 3574 * 3575 * @global int $content_width 3576 * 3577 * @param array $attr { 3578 * Attributes of the shortcode. 3579 * 3580 * @type string $src URL to the source of the video file. Default empty. 3581 * @type int $height Height of the video embed in pixels. Default 360. 3582 * @type int $width Width of the video embed in pixels. Default $content_width or 640. 3583 * @type string $poster The 'poster' attribute for the `<video>` element. Default empty. 3584 * @type string $loop The 'loop' attribute for the `<video>` element. Default empty. 3585 * @type string $autoplay The 'autoplay' attribute for the `<video>` element. Default empty. 3586 * @type string $muted The 'muted' attribute for the `<video>` element. Default false. 3587 * @type string $preload The 'preload' attribute for the `<video>` element. 3588 * Default 'metadata'. 3589 * @type string $class The 'class' attribute for the `<video>` element. 3590 * Default 'wp-video-shortcode'. 3591 * } 3592 * @param string $content Shortcode content. 3593 * @return string|void HTML content to display video. 3594 */ 3595 function wp_video_shortcode( $attr, $content = '' ) { 3596 global $content_width; 3597 $post_id = get_post() ? get_the_ID() : 0; 3598 3599 static $instance = 0; 3600 ++$instance; 3601 3602 /** 3603 * Filters the default video shortcode output. 3604 * 3605 * If the filtered output isn't empty, it will be used instead of generating 3606 * the default video template. 3607 * 3608 * @since 3.6.0 3609 * 3610 * @see wp_video_shortcode() 3611 * 3612 * @param string $html Empty variable to be replaced with shortcode markup. 3613 * @param array $attr Attributes of the shortcode. See {@see wp_video_shortcode()}. 3614 * @param string $content Video shortcode content. 3615 * @param int $instance Unique numeric ID of this video shortcode instance. 3616 */ 3617 $override = apply_filters( 'wp_video_shortcode_override', '', $attr, $content, $instance ); 3618 3619 if ( '' !== $override ) { 3620 return $override; 3621 } 3622 3623 $video = null; 3624 3625 $default_types = wp_get_video_extensions(); 3626 $defaults_atts = array( 3627 'src' => '', 3628 'poster' => '', 3629 'loop' => '', 3630 'autoplay' => '', 3631 'muted' => 'false', 3632 'preload' => 'metadata', 3633 'width' => 640, 3634 'height' => 360, 3635 'class' => 'wp-video-shortcode', 3636 ); 3637 3638 foreach ( $default_types as $type ) { 3639 $defaults_atts[ $type ] = ''; 3640 } 3641 3642 $atts = shortcode_atts( $defaults_atts, $attr, 'video' ); 3643 3644 if ( is_admin() ) { 3645 // Shrink the video so it isn't huge in the admin. 3646 if ( $atts['width'] > $defaults_atts['width'] ) { 3647 $atts['height'] = round( ( $atts['height'] * $defaults_atts['width'] ) / $atts['width'] ); 3648 $atts['width'] = $defaults_atts['width']; 3649 } 3650 } else { 3651 // If the video is bigger than the theme. 3652 if ( ! empty( $content_width ) && $atts['width'] > $content_width ) { 3653 $atts['height'] = round( ( $atts['height'] * $content_width ) / $atts['width'] ); 3654 $atts['width'] = $content_width; 3655 } 3656 } 3657 3658 $is_vimeo = false; 3659 $is_youtube = false; 3660 $yt_pattern = '#^https?://(?:www\.)?(?:youtube\.com/watch|youtu\.be/)#'; 3661 $vimeo_pattern = '#^https?://(.+\.)?vimeo\.com/.*#'; 3662 3663 $primary = false; 3664 if ( ! empty( $atts['src'] ) ) { 3665 $is_vimeo = ( preg_match( $vimeo_pattern, $atts['src'] ) ); 3666 $is_youtube = ( preg_match( $yt_pattern, $atts['src'] ) ); 3667 3668 if ( ! $is_youtube && ! $is_vimeo ) { 3669 $type = wp_check_filetype( $atts['src'], wp_get_mime_types() ); 3670 3671 if ( ! in_array( strtolower( $type['ext'] ), $default_types, true ) ) { 3672 return sprintf( '<a class="wp-embedded-video" href="%s">%s</a>', esc_url( $atts['src'] ), esc_html( $atts['src'] ) ); 3673 } 3674 } 3675 3676 if ( $is_vimeo ) { 3677 wp_enqueue_script( 'mediaelement-vimeo' ); 3678 } 3679 3680 $primary = true; 3681 array_unshift( $default_types, 'src' ); 3682 } else { 3683 foreach ( $default_types as $ext ) { 3684 if ( ! empty( $atts[ $ext ] ) ) { 3685 $type = wp_check_filetype( $atts[ $ext ], wp_get_mime_types() ); 3686 if ( strtolower( $type['ext'] ) === $ext ) { 3687 $primary = true; 3688 } 3689 } 3690 } 3691 } 3692 3693 if ( ! $primary ) { 3694 $videos = get_attached_media( 'video', $post_id ); 3695 if ( empty( $videos ) ) { 3696 return; 3697 } 3698 3699 $video = reset( $videos ); 3700 $atts['src'] = wp_get_attachment_url( $video->ID ); 3701 if ( empty( $atts['src'] ) ) { 3702 return; 3703 } 3704 3705 array_unshift( $default_types, 'src' ); 3706 } 3707 3708 /** 3709 * Filters the media library used for the video shortcode. 3710 * 3711 * @since 3.6.0 3712 * 3713 * @param string $library Media library used for the video shortcode. 3714 */ 3715 $library = apply_filters( 'wp_video_shortcode_library', 'mediaelement' ); 3716 if ( 'mediaelement' === $library && did_action( 'init' ) ) { 3717 wp_enqueue_style( 'wp-mediaelement' ); 3718 wp_enqueue_script( 'wp-mediaelement' ); 3719 wp_enqueue_script( 'mediaelement-vimeo' ); 3720 } 3721 3722 /* 3723 * MediaElement.js has issues with some URL formats for Vimeo and YouTube, 3724 * so update the URL to prevent the ME.js player from breaking. 3725 */ 3726 if ( 'mediaelement' === $library ) { 3727 if ( $is_youtube ) { 3728 // Remove `feature` query arg and force SSL - see #40866. 3729 $atts['src'] = remove_query_arg( 'feature', $atts['src'] ); 3730 $atts['src'] = set_url_scheme( $atts['src'], 'https' ); 3731 } elseif ( $is_vimeo ) { 3732 // Remove all query arguments and force SSL - see #40866. 3733 $parsed_vimeo_url = wp_parse_url( $atts['src'] ); 3734 $vimeo_src = 'https://' . $parsed_vimeo_url['host'] . $parsed_vimeo_url['path']; 3735 3736 // Add loop param for mejs bug - see #40977, not needed after #39686. 3737 $loop = $atts['loop'] ? '1' : '0'; 3738 $atts['src'] = add_query_arg( 'loop', $loop, $vimeo_src ); 3739 } 3740 } 3741 3742 /** 3743 * Filters the class attribute for the video shortcode output container. 3744 * 3745 * @since 3.6.0 3746 * @since 4.9.0 The `$atts` parameter was added. 3747 * 3748 * @param string $class CSS class or list of space-separated classes. 3749 * @param array $atts Array of video shortcode attributes. 3750 */ 3751 $atts['class'] = apply_filters( 'wp_video_shortcode_class', $atts['class'], $atts ); 3752 3753 $html_atts = array( 3754 'class' => $atts['class'], 3755 'id' => sprintf( 'video-%d-%d', $post_id, $instance ), 3756 'width' => absint( $atts['width'] ), 3757 'height' => absint( $atts['height'] ), 3758 'poster' => esc_url( $atts['poster'] ), 3759 'loop' => wp_validate_boolean( $atts['loop'] ), 3760 'autoplay' => wp_validate_boolean( $atts['autoplay'] ), 3761 'muted' => wp_validate_boolean( $atts['muted'] ), 3762 'preload' => $atts['preload'], 3763 ); 3764 3765 // These ones should just be omitted altogether if they are blank. 3766 foreach ( array( 'poster', 'loop', 'autoplay', 'preload', 'muted' ) as $a ) { 3767 if ( empty( $html_atts[ $a ] ) ) { 3768 unset( $html_atts[ $a ] ); 3769 } 3770 } 3771 3772 $attr_strings = array(); 3773 foreach ( $html_atts as $attribute_name => $attribute_value ) { 3774 if ( in_array( $attribute_name, array( 'loop', 'autoplay', 'muted' ), true ) && true === $attribute_value ) { 3775 // Add boolean attributes without their value for true. 3776 $attr_strings[] = esc_attr( $attribute_name ); 3777 } elseif ( 'preload' === $attribute_name && ! empty( $attribute_value ) ) { 3778 // Handle the preload attribute with specific allowed values. 3779 $allowed_preload_values = array( 'none', 'metadata', 'auto' ); 3780 if ( in_array( $attribute_value, $allowed_preload_values, true ) ) { 3781 $attr_strings[] = sprintf( '%s="%s"', esc_attr( $attribute_name ), esc_attr( $attribute_value ) ); 3782 } 3783 } elseif ( ! empty( $attribute_value ) ) { 3784 // For non-boolean attributes, add them with their value. 3785 $attr_strings[] = sprintf( '%s="%s"', esc_attr( $attribute_name ), esc_attr( $attribute_value ) ); 3786 } 3787 } 3788 3789 $html = sprintf( '<video %s controls="controls">', implode( ' ', $attr_strings ) ); 3790 $fileurl = ''; 3791 $source = '<source type="%s" src="%s" />'; 3792 3793 foreach ( $default_types as $fallback ) { 3794 if ( ! empty( $atts[ $fallback ] ) ) { 3795 if ( empty( $fileurl ) ) { 3796 $fileurl = $atts[ $fallback ]; 3797 } 3798 if ( 'src' === $fallback && $is_youtube ) { 3799 $type = array( 'type' => 'video/youtube' ); 3800 } elseif ( 'src' === $fallback && $is_vimeo ) { 3801 $type = array( 'type' => 'video/vimeo' ); 3802 } else { 3803 $type = wp_check_filetype( $atts[ $fallback ], wp_get_mime_types() ); 3804 } 3805 $url = add_query_arg( '_', $instance, $atts[ $fallback ] ); 3806 $html .= sprintf( $source, $type['type'], esc_url( $url ) ); 3807 } 3808 } 3809 3810 if ( ! empty( $content ) ) { 3811 if ( str_contains( $content, "\n" ) ) { 3812 $content = str_replace( array( "\r\n", "\n", "\t" ), '', $content ); 3813 } 3814 $html .= trim( $content ); 3815 } 3816 3817 if ( 'mediaelement' === $library ) { 3818 $html .= wp_mediaelement_fallback( $fileurl ); 3819 } 3820 $html .= '</video>'; 3821 3822 $width_rule = ''; 3823 if ( ! empty( $atts['width'] ) ) { 3824 $width_rule = sprintf( 'width: %dpx;', $atts['width'] ); 3825 } 3826 $output = sprintf( '<div style="%s" class="wp-video">%s</div>', $width_rule, $html ); 3827 3828 /** 3829 * Filters the output of the video shortcode. 3830 * 3831 * @since 3.6.0 3832 * 3833 * @param string $output Video shortcode HTML output. 3834 * @param array $atts Array of video shortcode attributes. 3835 * @param string $video Video file. 3836 * @param int $post_id Post ID. 3837 * @param string $library Media library used for the video shortcode. 3838 */ 3839 return apply_filters( 'wp_video_shortcode', $output, $atts, $video, $post_id, $library ); 3840 } 3841 add_shortcode( 'video', 'wp_video_shortcode' ); 3842 3843 /** 3844 * Gets the previous image link that has the same post parent. 3845 * 3846 * @since 5.8.0 3847 * 3848 * @see get_adjacent_image_link() 3849 * 3850 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array 3851 * of width and height values in pixels (in that order). Default 'thumbnail'. 3852 * @param string|false $text Optional. Link text. Default false. 3853 * @return string Markup for previous image link. 3854 */ 3855 function get_previous_image_link( $size = 'thumbnail', $text = false ) { 3856 return get_adjacent_image_link( true, $size, $text ); 3857 } 3858 3859 /** 3860 * Displays previous image link that has the same post parent. 3861 * 3862 * @since 2.5.0 3863 * 3864 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array 3865 * of width and height values in pixels (in that order). Default 'thumbnail'. 3866 * @param string|false $text Optional. Link text. Default false. 3867 */ 3868 function previous_image_link( $size = 'thumbnail', $text = false ) { 3869 echo get_previous_image_link( $size, $text ); 3870 } 3871 3872 /** 3873 * Gets the next image link that has the same post parent. 3874 * 3875 * @since 5.8.0 3876 * 3877 * @see get_adjacent_image_link() 3878 * 3879 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array 3880 * of width and height values in pixels (in that order). Default 'thumbnail'. 3881 * @param string|false $text Optional. Link text. Default false. 3882 * @return string Markup for next image link. 3883 */ 3884 function get_next_image_link( $size = 'thumbnail', $text = false ) { 3885 return get_adjacent_image_link( false, $size, $text ); 3886 } 3887 3888 /** 3889 * Displays next image link that has the same post parent. 3890 * 3891 * @since 2.5.0 3892 * 3893 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array 3894 * of width and height values in pixels (in that order). Default 'thumbnail'. 3895 * @param string|false $text Optional. Link text. Default false. 3896 */ 3897 function next_image_link( $size = 'thumbnail', $text = false ) { 3898 echo get_next_image_link( $size, $text ); 3899 } 3900 3901 /** 3902 * Gets the next or previous image link that has the same post parent. 3903 * 3904 * Retrieves the current attachment object from the $post global. 3905 * 3906 * @since 5.8.0 3907 * 3908 * @param bool $prev Optional. Whether to display the next (false) or previous (true) link. Default true. 3909 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array 3910 * of width and height values in pixels (in that order). Default 'thumbnail'. 3911 * @param bool $text Optional. Link text. Default false. 3912 * @return string Markup for image link. 3913 */ 3914 function get_adjacent_image_link( $prev = true, $size = 'thumbnail', $text = false ) { 3915 $post = get_post(); 3916 $attachments = array_values( 3917 get_children( 3918 array( 3919 'post_parent' => $post->post_parent, 3920 'post_status' => 'inherit', 3921 'post_type' => 'attachment', 3922 'post_mime_type' => 'image', 3923 'order' => 'ASC', 3924 'orderby' => 'menu_order ID', 3925 ) 3926 ) 3927 ); 3928 3929 foreach ( $attachments as $k => $attachment ) { 3930 if ( (int) $attachment->ID === (int) $post->ID ) { 3931 break; 3932 } 3933 } 3934 3935 $output = ''; 3936 $attachment_id = 0; 3937 3938 if ( $attachments ) { 3939 $k = $prev ? $k - 1 : $k + 1; 3940 3941 if ( isset( $attachments[ $k ] ) ) { 3942 $attachment_id = $attachments[ $k ]->ID; 3943 $attr = array( 'alt' => get_the_title( $attachment_id ) ); 3944 $output = wp_get_attachment_link( $attachment_id, $size, true, false, $text, $attr ); 3945 } 3946 } 3947 3948 $adjacent = $prev ? 'previous' : 'next'; 3949 3950 /** 3951 * Filters the adjacent image link. 3952 * 3953 * The dynamic portion of the hook name, `$adjacent`, refers to the type of adjacency, 3954 * either 'next', or 'previous'. 3955 * 3956 * Possible hook names include: 3957 * 3958 * - `next_image_link` 3959 * - `previous_image_link` 3960 * 3961 * @since 3.5.0 3962 * 3963 * @param string $output Adjacent image HTML markup. 3964 * @param int $attachment_id Attachment ID 3965 * @param string|int[] $size Requested image size. Can be any registered image size name, or 3966 * an array of width and height values in pixels (in that order). 3967 * @param string $text Link text. 3968 */ 3969 return apply_filters( "{$adjacent}_image_link", $output, $attachment_id, $size, $text ); 3970 } 3971 3972 /** 3973 * Displays next or previous image link that has the same post parent. 3974 * 3975 * Retrieves the current attachment object from the $post global. 3976 * 3977 * @since 2.5.0 3978 * 3979 * @param bool $prev Optional. Whether to display the next (false) or previous (true) link. Default true. 3980 * @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array 3981 * of width and height values in pixels (in that order). Default 'thumbnail'. 3982 * @param bool $text Optional. Link text. Default false. 3983 */ 3984 function adjacent_image_link( $prev = true, $size = 'thumbnail', $text = false ) { 3985 echo get_adjacent_image_link( $prev, $size, $text ); 3986 } 3987 3988 /** 3989 * Retrieves taxonomies attached to given the attachment. 3990 * 3991 * @since 2.5.0 3992 * @since 4.7.0 Introduced the `$output` parameter. 3993 * 3994 * @param int|array|object $attachment Attachment ID, data array, or data object. 3995 * @param string $output Output type. 'names' to return an array of taxonomy names, 3996 * or 'objects' to return an array of taxonomy objects. 3997 * Default is 'names'. 3998 * @return string[]|WP_Taxonomy[] List of taxonomies or taxonomy names. Empty array on failure. 3999 */ 4000 function get_attachment_taxonomies( $attachment, $output = 'names' ) { 4001 if ( is_int( $attachment ) ) { 4002 $attachment = get_post( $attachment ); 4003 } elseif ( is_array( $attachment ) ) { 4004 $attachment = (object) $attachment; 4005 } 4006 4007 if ( ! is_object( $attachment ) ) { 4008 return array(); 4009 } 4010 4011 $file = get_attached_file( $attachment->ID ); 4012 $filename = wp_basename( $file ); 4013 4014 $objects = array( 'attachment' ); 4015 4016 if ( str_contains( $filename, '.' ) ) { 4017 $objects[] = 'attachment:' . substr( $filename, strrpos( $filename, '.' ) + 1 ); 4018 } 4019 4020 if ( ! empty( $attachment->post_mime_type ) ) { 4021 $objects[] = 'attachment:' . $attachment->post_mime_type; 4022 4023 if ( str_contains( $attachment->post_mime_type, '/' ) ) { 4024 foreach ( explode( '/', $attachment->post_mime_type ) as $token ) { 4025 if ( ! empty( $token ) ) { 4026 $objects[] = "attachment:$token"; 4027 } 4028 } 4029 } 4030 } 4031 4032 $taxonomies = array(); 4033 4034 foreach ( $objects as $object ) { 4035 $taxes = get_object_taxonomies( $object, $output ); 4036 4037 if ( $taxes ) { 4038 $taxonomies = array_merge( $taxonomies, $taxes ); 4039 } 4040 } 4041 4042 if ( 'names' === $output ) { 4043 $taxonomies = array_unique( $taxonomies ); 4044 } 4045 4046 return $taxonomies; 4047 } 4048 4049 /** 4050 * Retrieves all of the taxonomies that are registered for attachments. 4051 * 4052 * Handles mime-type-specific taxonomies such as attachment:image and attachment:video. 4053 * 4054 * @since 3.5.0 4055 * 4056 * @see get_taxonomies() 4057 * 4058 * @param string $output Optional. The type of taxonomy output to return. Accepts 'names' or 'objects'. 4059 * Default 'names'. 4060 * @return string[]|WP_Taxonomy[] Array of names or objects of registered taxonomies for attachments. 4061 */ 4062 function get_taxonomies_for_attachments( $output = 'names' ) { 4063 $taxonomies = array(); 4064 4065 foreach ( get_taxonomies( array(), 'objects' ) as $taxonomy ) { 4066 foreach ( $taxonomy->object_type as $object_type ) { 4067 if ( 'attachment' === $object_type || str_starts_with( $object_type, 'attachment:' ) ) { 4068 if ( 'names' === $output ) { 4069 $taxonomies[] = $taxonomy->name; 4070 } else { 4071 $taxonomies[ $taxonomy->name ] = $taxonomy; 4072 } 4073 break; 4074 } 4075 } 4076 } 4077 4078 return $taxonomies; 4079 } 4080 4081 /** 4082 * Determines whether the value is an acceptable type for GD image functions. 4083 * 4084 * In PHP 8.0, the GD extension uses GdImage objects for its data structures. 4085 * This function checks if the passed value is either a GdImage object instance 4086 * or a resource of type `gd`. Any other type will return false. 4087 * 4088 * @since 5.6.0 4089 * 4090 * @param resource|GdImage|false $image A value to check the type for. 4091 * @return bool True if `$image` is either a GD image resource or a GdImage instance, 4092 * false otherwise. 4093 */ 4094 function is_gd_image( $image ) { 4095 if ( $image instanceof GdImage 4096 || is_resource( $image ) && 'gd' === get_resource_type( $image ) 4097 ) { 4098 return true; 4099 } 4100 4101 return false; 4102 } 4103 4104 /** 4105 * Creates a new GD image resource with transparency support. 4106 * 4107 * @todo Deprecate if possible. 4108 * 4109 * @since 2.9.0 4110 * 4111 * @param int $width Image width in pixels. 4112 * @param int $height Image height in pixels. 4113 * @return resource|GdImage|false The GD image resource or GdImage instance on success. 4114 * False on failure. 4115 */ 4116 function wp_imagecreatetruecolor( $width, $height ) { 4117 $img = imagecreatetruecolor( $width, $height ); 4118 4119 if ( is_gd_image( $img ) 4120 && function_exists( 'imagealphablending' ) && function_exists( 'imagesavealpha' ) 4121 ) { 4122 imagealphablending( $img, false ); 4123 imagesavealpha( $img, true ); 4124 } 4125 4126 return $img; 4127 } 4128 4129 /** 4130 * Based on a supplied width/height example, returns the biggest possible dimensions based on the max width/height. 4131 * 4132 * @since 2.9.0 4133 * 4134 * @see wp_constrain_dimensions() 4135 * 4136 * @param int $example_width The width of an example embed. 4137 * @param int $example_height The height of an example embed. 4138 * @param int $max_width The maximum allowed width. 4139 * @param int $max_height The maximum allowed height. 4140 * @return int[] { 4141 * An array of maximum width and height values. 4142 * 4143 * @type int $0 The maximum width in pixels. 4144 * @type int $1 The maximum height in pixels. 4145 * } 4146 */ 4147 function wp_expand_dimensions( $example_width, $example_height, $max_width, $max_height ) { 4148 $example_width = (int) $example_width; 4149 $example_height = (int) $example_height; 4150 $max_width = (int) $max_width; 4151 $max_height = (int) $max_height; 4152 4153 return wp_constrain_dimensions( $example_width * 1000000, $example_height * 1000000, $max_width, $max_height ); 4154 } 4155 4156 /** 4157 * Determines the maximum upload size allowed in php.ini. 4158 * 4159 * @since 2.5.0 4160 * 4161 * @return int Allowed upload size. 4162 */ 4163 function wp_max_upload_size() { 4164 $u_bytes = wp_convert_hr_to_bytes( ini_get( 'upload_max_filesize' ) ); 4165 $p_bytes = wp_convert_hr_to_bytes( ini_get( 'post_max_size' ) ); 4166 4167 /** 4168 * Filters the maximum upload size allowed in php.ini. 4169 * 4170 * @since 2.5.0 4171 * 4172 * @param int $size Max upload size limit in bytes. 4173 * @param int $u_bytes Maximum upload filesize in bytes. 4174 * @param int $p_bytes Maximum size of POST data in bytes. 4175 */ 4176 return apply_filters( 'upload_size_limit', min( $u_bytes, $p_bytes ), $u_bytes, $p_bytes ); 4177 } 4178 4179 /** 4180 * Returns a WP_Image_Editor instance and loads file into it. 4181 * 4182 * @since 3.5.0 4183 * 4184 * @param string $path Path to the file to load. 4185 * @param array $args Optional. Additional arguments for retrieving the image editor. 4186 * Default empty array. 4187 * @return WP_Image_Editor|WP_Error The WP_Image_Editor object on success, 4188 * a WP_Error object otherwise. 4189 */ 4190 function wp_get_image_editor( $path, $args = array() ) { 4191 $args['path'] = $path; 4192 4193 // If the mime type is not set in args, try to extract and set it from the file. 4194 if ( ! isset( $args['mime_type'] ) ) { 4195 $file_info = wp_check_filetype( $args['path'] ); 4196 4197 /* 4198 * If $file_info['type'] is false, then we let the editor attempt to 4199 * figure out the file type, rather than forcing a failure based on extension. 4200 */ 4201 if ( isset( $file_info ) && $file_info['type'] ) { 4202 $args['mime_type'] = $file_info['type']; 4203 } 4204 } 4205 4206 // Check and set the output mime type mapped to the input type. 4207 if ( isset( $args['mime_type'] ) ) { 4208 $output_format = wp_get_image_editor_output_format( $path, $args['mime_type'] ); 4209 if ( isset( $output_format[ $args['mime_type'] ] ) ) { 4210 $args['output_mime_type'] = $output_format[ $args['mime_type'] ]; 4211 } 4212 } 4213 4214 $implementation = _wp_image_editor_choose( $args ); 4215 4216 if ( $implementation ) { 4217 $editor = new $implementation( $path ); 4218 $loaded = $editor->load(); 4219 4220 if ( is_wp_error( $loaded ) ) { 4221 return $loaded; 4222 } 4223 4224 return $editor; 4225 } 4226 4227 return new WP_Error( 'image_no_editor', __( 'No editor could be selected.' ) ); 4228 } 4229 4230 /** 4231 * Tests whether there is an editor that supports a given mime type or methods. 4232 * 4233 * @since 3.5.0 4234 * 4235 * @param string|array $args Optional. Array of arguments to retrieve the image editor supports. 4236 * Default empty array. 4237 * @return bool True if an eligible editor is found; false otherwise. 4238 */ 4239 function wp_image_editor_supports( $args = array() ) { 4240 return (bool) _wp_image_editor_choose( $args ); 4241 } 4242 4243 /** 4244 * Tests which editors are capable of supporting the request. 4245 * 4246 * @ignore 4247 * @since 3.5.0 4248 * 4249 * @param array $args Optional. Array of arguments for choosing a capable editor. Default empty array. 4250 * @return string|false Class name for the first editor that claims to support the request. 4251 * False if no editor claims to support the request. 4252 */ 4253 function _wp_image_editor_choose( $args = array() ) { 4254 require_once ABSPATH . WPINC . '/class-wp-image-editor.php'; 4255 require_once ABSPATH . WPINC . '/class-wp-image-editor-gd.php'; 4256 require_once ABSPATH . WPINC . '/class-wp-image-editor-imagick.php'; 4257 require_once ABSPATH . WPINC . '/class-avif-info.php'; 4258 /** 4259 * Filters the list of image editing library classes. 4260 * 4261 * @since 3.5.0 4262 * 4263 * @param string[] $image_editors Array of available image editor class names. Defaults are 4264 * 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD'. 4265 */ 4266 $implementations = apply_filters( 'wp_image_editors', array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) ); 4267 4268 $editors = wp_cache_get( 'wp_image_editor_choose', 'image_editor' ); 4269 4270 if ( ! is_array( $editors ) ) { 4271 $editors = array(); 4272 } 4273 4274 // Cache the chosen editor implementation based on specific args and available implementations. 4275 $cache_key = md5( serialize( array( $args, $implementations ) ) ); 4276 4277 if ( isset( $editors[ $cache_key ] ) ) { 4278 return $editors[ $cache_key ]; 4279 } 4280 4281 // Assume no support until a capable implementation is identified. 4282 $editor = false; 4283 4284 foreach ( $implementations as $implementation ) { 4285 if ( ! call_user_func( array( $implementation, 'test' ), $args ) ) { 4286 continue; 4287 } 4288 4289 // Implementation should support the passed mime type. 4290 if ( isset( $args['mime_type'] ) && 4291 ! call_user_func( 4292 array( $implementation, 'supports_mime_type' ), 4293 $args['mime_type'] 4294 ) ) { 4295 continue; 4296 } 4297 4298 // Implementation should support requested methods. 4299 if ( isset( $args['methods'] ) && 4300 array_diff( $args['methods'], get_class_methods( $implementation ) ) ) { 4301 4302 continue; 4303 } 4304 4305 // Implementation should ideally support the output mime type as well if set and different than the passed type. 4306 if ( 4307 isset( $args['mime_type'] ) && 4308 isset( $args['output_mime_type'] ) && 4309 $args['mime_type'] !== $args['output_mime_type'] && 4310 ! call_user_func( array( $implementation, 'supports_mime_type' ), $args['output_mime_type'] ) 4311 ) { 4312 /* 4313 * This implementation supports the input type but not the output type. 4314 * Keep looking to see if we can find an implementation that supports both. 4315 */ 4316 $editor = $implementation; 4317 continue; 4318 } 4319 4320 // Favor the implementation that supports both input and output mime types. 4321 $editor = $implementation; 4322 break; 4323 } 4324 4325 $editors[ $cache_key ] = $editor; 4326 4327 wp_cache_set( 'wp_image_editor_choose', $editors, 'image_editor', DAY_IN_SECONDS ); 4328 4329 return $editor; 4330 } 4331 4332 /** 4333 * Prints default Plupload arguments. 4334 * 4335 * @since 3.4.0 4336 */ 4337 function wp_plupload_default_settings() { 4338 $wp_scripts = wp_scripts(); 4339 4340 $data = $wp_scripts->get_data( 'wp-plupload', 'data' ); 4341 if ( $data && str_contains( $data, '_wpPluploadSettings' ) ) { 4342 return; 4343 } 4344 4345 $max_upload_size = wp_max_upload_size(); 4346 $allowed_extensions = array_keys( get_allowed_mime_types() ); 4347 $extensions = array(); 4348 foreach ( $allowed_extensions as $extension ) { 4349 $extensions = array_merge( $extensions, explode( '|', $extension ) ); 4350 } 4351 4352 /* 4353 * Since 4.9 the `runtimes` setting is hardcoded in our version of Plupload to `html5,html4`, 4354 * and the `flash_swf_url` and `silverlight_xap_url` are not used. 4355 */ 4356 $defaults = array( 4357 'file_data_name' => 'async-upload', // Key passed to $_FILE. 4358 'url' => admin_url( 'async-upload.php', 'relative' ), 4359 'filters' => array( 4360 'max_file_size' => $max_upload_size . 'b', 4361 'mime_types' => array( array( 'extensions' => implode( ',', $extensions ) ) ), 4362 ), 4363 ); 4364 4365 /* 4366 * Currently only iOS Safari supports multiple files uploading, 4367 * but iOS 7.x has a bug that prevents uploading of videos when enabled. 4368 * See #29602. 4369 */ 4370 if ( wp_is_mobile() 4371 && str_contains( $_SERVER['HTTP_USER_AGENT'], 'OS 7_' ) 4372 && str_contains( $_SERVER['HTTP_USER_AGENT'], 'like Mac OS X' ) 4373 ) { 4374 $defaults['multi_selection'] = false; 4375 } 4376 4377 // Check if WebP images can be edited. 4378 if ( ! wp_image_editor_supports( array( 'mime_type' => 'image/webp' ) ) ) { 4379 $defaults['webp_upload_error'] = true; 4380 } 4381 4382 // Check if AVIF images can be edited. 4383 if ( ! wp_image_editor_supports( array( 'mime_type' => 'image/avif' ) ) ) { 4384 $defaults['avif_upload_error'] = true; 4385 } 4386 4387 // Check if HEIC images can be edited. 4388 if ( ! wp_image_editor_supports( array( 'mime_type' => 'image/heic' ) ) ) { 4389 $defaults['heic_upload_error'] = true; 4390 } 4391 4392 /** 4393 * Filters the Plupload default settings. 4394 * 4395 * @since 3.4.0 4396 * 4397 * @param array $defaults Default Plupload settings array. 4398 */ 4399 $defaults = apply_filters( 'plupload_default_settings', $defaults ); 4400 4401 $params = array( 4402 'action' => 'upload-attachment', 4403 ); 4404 4405 /** 4406 * Filters the Plupload default parameters. 4407 * 4408 * @since 3.4.0 4409 * 4410 * @param array $params Default Plupload parameters array. 4411 */ 4412 $params = apply_filters( 'plupload_default_params', $params ); 4413 4414 $params['_wpnonce'] = wp_create_nonce( 'media-form' ); 4415 4416 $defaults['multipart_params'] = $params; 4417 4418 $settings = array( 4419 'defaults' => $defaults, 4420 'browser' => array( 4421 'mobile' => wp_is_mobile(), 4422 'supported' => _device_can_upload(), 4423 ), 4424 'limitExceeded' => is_multisite() && ! is_upload_space_available(), 4425 ); 4426 4427 $script = 'var _wpPluploadSettings = ' . wp_json_encode( $settings ) . ';'; 4428 4429 if ( $data ) { 4430 $script = "$data\n$script"; 4431 } 4432 4433 $wp_scripts->add_data( 'wp-plupload', 'data', $script ); 4434 } 4435 4436 /** 4437 * Prepares an attachment post object for JS, where it is expected 4438 * to be JSON-encoded and fit into an Attachment model. 4439 * 4440 * @since 3.5.0 4441 * 4442 * @param int|WP_Post $attachment Attachment ID or object. 4443 * @return array|void { 4444 * Array of attachment details, or void if the parameter does not correspond to an attachment. 4445 * 4446 * @type string $alt Alt text of the attachment. 4447 * @type string $author ID of the attachment author, as a string. 4448 * @type string $authorName Name of the attachment author. 4449 * @type string $caption Caption for the attachment. 4450 * @type array $compat Containing item and meta. 4451 * @type string $context Context, whether it's used as the site icon for example. 4452 * @type int $date Uploaded date, timestamp in milliseconds. 4453 * @type string $dateFormatted Formatted date (e.g. June 29, 2018). 4454 * @type string $description Description of the attachment. 4455 * @type string $editLink URL to the edit page for the attachment. 4456 * @type string $filename File name of the attachment. 4457 * @type string $filesizeHumanReadable Filesize of the attachment in human readable format (e.g. 1 MB). 4458 * @type int $filesizeInBytes Filesize of the attachment in bytes. 4459 * @type int $height If the attachment is an image, represents the height of the image in pixels. 4460 * @type string $icon Icon URL of the attachment (e.g. /wp-includes/images/media/archive.png). 4461 * @type int $id ID of the attachment. 4462 * @type string $link URL to the attachment. 4463 * @type int $menuOrder Menu order of the attachment post. 4464 * @type array $meta Meta data for the attachment. 4465 * @type string $mime Mime type of the attachment (e.g. image/jpeg or application/zip). 4466 * @type int $modified Last modified, timestamp in milliseconds. 4467 * @type string $name Name, same as title of the attachment. 4468 * @type array $nonces Nonces for update, delete and edit. 4469 * @type string $orientation If the attachment is an image, represents the image orientation 4470 * (landscape or portrait). 4471 * @type array $sizes If the attachment is an image, contains an array of arrays 4472 * for the images sizes: thumbnail, medium, large, and full. 4473 * @type string $status Post status of the attachment (usually 'inherit'). 4474 * @type string $subtype Mime subtype of the attachment (usually the last part, e.g. jpeg or zip). 4475 * @type string $title Title of the attachment (usually slugified file name without the extension). 4476 * @type string $type Type of the attachment (usually first part of the mime type, e.g. image). 4477 * @type int $uploadedTo Parent post to which the attachment was uploaded. 4478 * @type string $uploadedToLink URL to the edit page of the parent post of the attachment. 4479 * @type string $uploadedToTitle Post title of the parent of the attachment. 4480 * @type string $url Direct URL to the attachment file (from wp-content). 4481 * @type int $width If the attachment is an image, represents the width of the image in pixels. 4482 * } 4483 */ 4484 function wp_prepare_attachment_for_js( $attachment ) { 4485 $attachment = get_post( $attachment ); 4486 4487 if ( ! $attachment ) { 4488 return; 4489 } 4490 4491 if ( 'attachment' !== $attachment->post_type ) { 4492 return; 4493 } 4494 4495 $meta = wp_get_attachment_metadata( $attachment->ID ); 4496 if ( str_contains( $attachment->post_mime_type, '/' ) ) { 4497 list( $type, $subtype ) = explode( '/', $attachment->post_mime_type ); 4498 } else { 4499 list( $type, $subtype ) = array( $attachment->post_mime_type, '' ); 4500 } 4501 4502 $attachment_url = wp_get_attachment_url( $attachment->ID ); 4503 $base_url = str_replace( wp_basename( $attachment_url ), '', $attachment_url ); 4504 4505 $response = array( 4506 'id' => $attachment->ID, 4507 'title' => $attachment->post_title, 4508 'filename' => wp_basename( get_attached_file( $attachment->ID ) ), 4509 'url' => $attachment_url, 4510 'link' => get_attachment_link( $attachment->ID ), 4511 'alt' => get_post_meta( $attachment->ID, '_wp_attachment_image_alt', true ), 4512 'author' => $attachment->post_author, 4513 'description' => $attachment->post_content, 4514 'caption' => $attachment->post_excerpt, 4515 'name' => $attachment->post_name, 4516 'status' => $attachment->post_status, 4517 'uploadedTo' => $attachment->post_parent, 4518 'date' => strtotime( $attachment->post_date_gmt ) * 1000, 4519 'modified' => strtotime( $attachment->post_modified_gmt ) * 1000, 4520 'menuOrder' => $attachment->menu_order, 4521 'mime' => $attachment->post_mime_type, 4522 'type' => $type, 4523 'subtype' => $subtype, 4524 'icon' => wp_mime_type_icon( $attachment->ID, '.svg' ), 4525 'dateFormatted' => mysql2date( __( 'F j, Y' ), $attachment->post_date ), 4526 'nonces' => array( 4527 'update' => false, 4528 'delete' => false, 4529 'edit' => false, 4530 ), 4531 'editLink' => false, 4532 'meta' => false, 4533 ); 4534 4535 $author = new WP_User( $attachment->post_author ); 4536 4537 if ( $author->exists() ) { 4538 $author_name = $author->display_name ? $author->display_name : $author->nickname; 4539 $response['authorName'] = html_entity_decode( $author_name, ENT_QUOTES, get_bloginfo( 'charset' ) ); 4540 $response['authorLink'] = get_edit_user_link( $author->ID ); 4541 } else { 4542 $response['authorName'] = __( '(no author)' ); 4543 } 4544 4545 if ( $attachment->post_parent ) { 4546 $post_parent = get_post( $attachment->post_parent ); 4547 if ( $post_parent ) { 4548 $response['uploadedToTitle'] = $post_parent->post_title ? $post_parent->post_title : __( '(no title)' ); 4549 $response['uploadedToLink'] = get_edit_post_link( $attachment->post_parent, 'raw' ); 4550 } 4551 } 4552 4553 $attached_file = get_attached_file( $attachment->ID ); 4554 4555 if ( isset( $meta['filesize'] ) ) { 4556 $bytes = $meta['filesize']; 4557 } elseif ( file_exists( $attached_file ) ) { 4558 $bytes = wp_filesize( $attached_file ); 4559 } else { 4560 $bytes = ''; 4561 } 4562 4563 if ( $bytes ) { 4564 $response['filesizeInBytes'] = $bytes; 4565 $response['filesizeHumanReadable'] = size_format( $bytes ); 4566 } 4567 4568 $context = get_post_meta( $attachment->ID, '_wp_attachment_context', true ); 4569 $response['context'] = ( $context ) ? $context : ''; 4570 4571 if ( current_user_can( 'edit_post', $attachment->ID ) ) { 4572 $response['nonces']['update'] = wp_create_nonce( 'update-post_' . $attachment->ID ); 4573 $response['nonces']['edit'] = wp_create_nonce( 'image_editor-' . $attachment->ID ); 4574 $response['editLink'] = get_edit_post_link( $attachment->ID, 'raw' ); 4575 } 4576 4577 if ( current_user_can( 'delete_post', $attachment->ID ) ) { 4578 $response['nonces']['delete'] = wp_create_nonce( 'delete-post_' . $attachment->ID ); 4579 } 4580 4581 if ( $meta && ( 'image' === $type || ! empty( $meta['sizes'] ) ) ) { 4582 $sizes = array(); 4583 4584 /** This filter is documented in wp-admin/includes/media.php */ 4585 $possible_sizes = apply_filters( 4586 'image_size_names_choose', 4587 array( 4588 'thumbnail' => __( 'Thumbnail' ), 4589 'medium' => __( 'Medium' ), 4590 'large' => __( 'Large' ), 4591 'full' => __( 'Full Size' ), 4592 ) 4593 ); 4594 unset( $possible_sizes['full'] ); 4595 4596 /* 4597 * Loop through all potential sizes that may be chosen. Try to do this with some efficiency. 4598 * First: run the image_downsize filter. If it returns something, we can use its data. 4599 * If the filter does not return something, then image_downsize() is just an expensive way 4600 * to check the image metadata, which we do second. 4601 */ 4602 foreach ( $possible_sizes as $size => $label ) { 4603 4604 /** This filter is documented in wp-includes/media.php */ 4605 $downsize = apply_filters( 'image_downsize', false, $attachment->ID, $size ); 4606 4607 if ( $downsize ) { 4608 if ( empty( $downsize[3] ) ) { 4609 continue; 4610 } 4611 4612 $sizes[ $size ] = array( 4613 'height' => $downsize[2], 4614 'width' => $downsize[1], 4615 'url' => $downsize[0], 4616 'orientation' => $downsize[2] > $downsize[1] ? 'portrait' : 'landscape', 4617 ); 4618 } elseif ( isset( $meta['sizes'][ $size ] ) ) { 4619 // Nothing from the filter, so consult image metadata if we have it. 4620 $size_meta = $meta['sizes'][ $size ]; 4621 4622 /* 4623 * We have the actual image size, but might need to further constrain it if content_width is narrower. 4624 * Thumbnail, medium, and full sizes are also checked against the site's height/width options. 4625 */ 4626 list( $width, $height ) = image_constrain_size_for_editor( $size_meta['width'], $size_meta['height'], $size, 'edit' ); 4627 4628 $sizes[ $size ] = array( 4629 'height' => $height, 4630 'width' => $width, 4631 'url' => $base_url . $size_meta['file'], 4632 'orientation' => $height > $width ? 'portrait' : 'landscape', 4633 ); 4634 } 4635 } 4636 4637 if ( 'image' === $type ) { 4638 if ( ! empty( $meta['original_image'] ) ) { 4639 $response['originalImageURL'] = wp_get_original_image_url( $attachment->ID ); 4640 $response['originalImageName'] = wp_basename( wp_get_original_image_path( $attachment->ID ) ); 4641 } 4642 4643 $sizes['full'] = array( 'url' => $attachment_url ); 4644 4645 if ( isset( $meta['height'], $meta['width'] ) ) { 4646 $sizes['full']['height'] = $meta['height']; 4647 $sizes['full']['width'] = $meta['width']; 4648 $sizes['full']['orientation'] = $meta['height'] > $meta['width'] ? 'portrait' : 'landscape'; 4649 } 4650 4651 $response = array_merge( $response, $sizes['full'] ); 4652 } elseif ( $meta['sizes']['full']['file'] ) { 4653 $sizes['full'] = array( 4654 'url' => $base_url . $meta['sizes']['full']['file'], 4655 'height' => $meta['sizes']['full']['height'], 4656 'width' => $meta['sizes']['full']['width'], 4657 'orientation' => $meta['sizes']['full']['height'] > $meta['sizes']['full']['width'] ? 'portrait' : 'landscape', 4658 ); 4659 } 4660 4661 $response = array_merge( $response, array( 'sizes' => $sizes ) ); 4662 } 4663 4664 if ( $meta && 'video' === $type ) { 4665 if ( isset( $meta['width'] ) ) { 4666 $response['width'] = (int) $meta['width']; 4667 } 4668 if ( isset( $meta['height'] ) ) { 4669 $response['height'] = (int) $meta['height']; 4670 } 4671 } 4672 4673 if ( $meta && ( 'audio' === $type || 'video' === $type ) ) { 4674 if ( isset( $meta['length_formatted'] ) ) { 4675 $response['fileLength'] = $meta['length_formatted']; 4676 $response['fileLengthHumanReadable'] = human_readable_duration( $meta['length_formatted'] ); 4677 } 4678 4679 $response['meta'] = array(); 4680 foreach ( wp_get_attachment_id3_keys( $attachment, 'js' ) as $key => $label ) { 4681 $response['meta'][ $key ] = false; 4682 4683 if ( ! empty( $meta[ $key ] ) ) { 4684 $response['meta'][ $key ] = $meta[ $key ]; 4685 } 4686 } 4687 4688 $id = get_post_thumbnail_id( $attachment->ID ); 4689 if ( ! empty( $id ) ) { 4690 list( $src, $width, $height ) = wp_get_attachment_image_src( $id, 'full' ); 4691 $response['image'] = compact( 'src', 'width', 'height' ); 4692 list( $src, $width, $height ) = wp_get_attachment_image_src( $id, 'thumbnail' ); 4693 $response['thumb'] = compact( 'src', 'width', 'height' ); 4694 } else { 4695 $src = wp_mime_type_icon( $attachment->ID, '.svg' ); 4696 $width = 48; 4697 $height = 64; 4698 $response['image'] = compact( 'src', 'width', 'height' ); 4699 $response['thumb'] = compact( 'src', 'width', 'height' ); 4700 } 4701 } 4702 4703 if ( function_exists( 'get_compat_media_markup' ) ) { 4704 $response['compat'] = get_compat_media_markup( $attachment->ID, array( 'in_modal' => true ) ); 4705 } 4706 4707 if ( function_exists( 'get_media_states' ) ) { 4708 $media_states = get_media_states( $attachment ); 4709 if ( ! empty( $media_states ) ) { 4710 $response['mediaStates'] = implode( ', ', $media_states ); 4711 } 4712 } 4713 4714 /** 4715 * Filters the attachment data prepared for JavaScript. 4716 * 4717 * @since 3.5.0 4718 * 4719 * @param array $response Array of prepared attachment data. See {@see wp_prepare_attachment_for_js()}. 4720 * @param WP_Post $attachment Attachment object. 4721 * @param array|false $meta Array of attachment meta data, or false if there is none. 4722 */ 4723 return apply_filters( 'wp_prepare_attachment_for_js', $response, $attachment, $meta ); 4724 } 4725 4726 /** 4727 * Enqueues all scripts, styles, settings, and templates necessary to use 4728 * all media JS APIs. 4729 * 4730 * @since 3.5.0 4731 * 4732 * @global int $content_width 4733 * @global wpdb $wpdb WordPress database abstraction object. 4734 * @global WP_Locale $wp_locale WordPress date and time locale object. 4735 * 4736 * @param array $args { 4737 * Arguments for enqueuing media scripts. 4738 * 4739 * @type int|WP_Post $post Post ID or post object. 4740 * } 4741 */ 4742 function wp_enqueue_media( $args = array() ) { 4743 // Enqueue me just once per page, please. 4744 if ( did_action( 'wp_enqueue_media' ) ) { 4745 return; 4746 } 4747 4748 global $content_width, $wpdb, $wp_locale; 4749 4750 $defaults = array( 4751 'post' => null, 4752 ); 4753 $args = wp_parse_args( $args, $defaults ); 4754 4755 /* 4756 * We're going to pass the old thickbox media tabs to `media_upload_tabs` 4757 * to ensure plugins will work. We will then unset those tabs. 4758 */ 4759 $tabs = array( 4760 // handler action suffix => tab label 4761 'type' => '', 4762 'type_url' => '', 4763 'gallery' => '', 4764 'library' => '', 4765 ); 4766 4767 /** This filter is documented in wp-admin/includes/media.php */ 4768 $tabs = apply_filters( 'media_upload_tabs', $tabs ); 4769 unset( $tabs['type'], $tabs['type_url'], $tabs['gallery'], $tabs['library'] ); 4770 4771 $props = array( 4772 'link' => get_option( 'image_default_link_type' ), // DB default is 'file'. 4773 'align' => get_option( 'image_default_align' ), // Empty default. 4774 'size' => get_option( 'image_default_size' ), // Empty default. 4775 ); 4776 4777 $exts = array_merge( wp_get_audio_extensions(), wp_get_video_extensions() ); 4778 $mimes = get_allowed_mime_types(); 4779 $ext_mimes = array(); 4780 foreach ( $exts as $ext ) { 4781 foreach ( $mimes as $ext_preg => $mime_match ) { 4782 if ( preg_match( '#' . $ext . '#i', $ext_preg ) ) { 4783 $ext_mimes[ $ext ] = $mime_match; 4784 break; 4785 } 4786 } 4787 } 4788 4789 /** 4790 * Allows showing or hiding the "Create Audio Playlist" button in the media library. 4791 * 4792 * By default, the "Create Audio Playlist" button will always be shown in 4793 * the media library. If this filter returns `null`, a query will be run 4794 * to determine whether the media library contains any audio items. This 4795 * was the default behavior prior to version 4.8.0, but this query is 4796 * expensive for large media libraries. 4797 * 4798 * @since 4.7.4 4799 * @since 4.8.0 The filter's default value is `true` rather than `null`. 4800 * 4801 * @link https://core.trac.wordpress.org/ticket/31071 4802 * 4803 * @param bool|null $show Whether to show the button, or `null` to decide based 4804 * on whether any audio files exist in the media library. 4805 */ 4806 $show_audio_playlist = apply_filters( 'media_library_show_audio_playlist', true ); 4807 if ( null === $show_audio_playlist ) { 4808 $show_audio_playlist = $wpdb->get_var( 4809 "SELECT ID 4810 FROM $wpdb->posts 4811 WHERE post_type = 'attachment' 4812 AND post_mime_type LIKE 'audio%' 4813 LIMIT 1" 4814 ); 4815 } 4816 4817 /** 4818 * Allows showing or hiding the "Create Video Playlist" button in the media library. 4819 * 4820 * By default, the "Create Video Playlist" button will always be shown in 4821 * the media library. If this filter returns `null`, a query will be run 4822 * to determine whether the media library contains any video items. This 4823 * was the default behavior prior to version 4.8.0, but this query is 4824 * expensive for large media libraries. 4825 * 4826 * @since 4.7.4 4827 * @since 4.8.0 The filter's default value is `true` rather than `null`. 4828 * 4829 * @link https://core.trac.wordpress.org/ticket/31071 4830 * 4831 * @param bool|null $show Whether to show the button, or `null` to decide based 4832 * on whether any video files exist in the media library. 4833 */ 4834 $show_video_playlist = apply_filters( 'media_library_show_video_playlist', true ); 4835 if ( null === $show_video_playlist ) { 4836 $show_video_playlist = $wpdb->get_var( 4837 "SELECT ID 4838 FROM $wpdb->posts 4839 WHERE post_type = 'attachment' 4840 AND post_mime_type LIKE 'video%' 4841 LIMIT 1" 4842 ); 4843 } 4844 4845 /** 4846 * Allows overriding the list of months displayed in the media library. 4847 * 4848 * By default (if this filter does not return an array), a query will be 4849 * run to determine the months that have media items. This query can be 4850 * expensive for large media libraries, so it may be desirable for sites to 4851 * override this behavior. 4852 * 4853 * @since 4.7.4 4854 * 4855 * @link https://core.trac.wordpress.org/ticket/31071 4856 * 4857 * @param stdClass[]|null $months An array of objects with `month` and `year` 4858 * properties, or `null` for default behavior. 4859 */ 4860 $months = apply_filters( 'media_library_months_with_files', null ); 4861 if ( ! is_array( $months ) ) { 4862 $months = $wpdb->get_results( 4863 $wpdb->prepare( 4864 "SELECT DISTINCT YEAR( post_date ) AS year, MONTH( post_date ) AS month 4865 FROM $wpdb->posts 4866 WHERE post_type = %s 4867 ORDER BY post_date DESC", 4868 'attachment' 4869 ) 4870 ); 4871 } 4872 foreach ( $months as $month_year ) { 4873 $month_year->text = sprintf( 4874 /* translators: 1: Month, 2: Year. */ 4875 __( '%1$s %2$d' ), 4876 $wp_locale->get_month( $month_year->month ), 4877 $month_year->year 4878 ); 4879 } 4880 4881 /** 4882 * Filters whether the Media Library grid has infinite scrolling. Default `false`. 4883 * 4884 * @since 5.8.0 4885 * 4886 * @param bool $infinite Whether the Media Library grid has infinite scrolling. 4887 */ 4888 $infinite_scrolling = apply_filters( 'media_library_infinite_scrolling', false ); 4889 4890 $settings = array( 4891 'tabs' => $tabs, 4892 'tabUrl' => add_query_arg( array( 'chromeless' => true ), admin_url( 'media-upload.php' ) ), 4893 'mimeTypes' => wp_list_pluck( get_post_mime_types(), 0 ), 4894 /** This filter is documented in wp-admin/includes/media.php */ 4895 'captions' => ! apply_filters( 'disable_captions', '' ), 4896 'nonce' => array( 4897 'sendToEditor' => wp_create_nonce( 'media-send-to-editor' ), 4898 'setAttachmentThumbnail' => wp_create_nonce( 'set-attachment-thumbnail' ), 4899 ), 4900 'post' => array( 4901 'id' => 0, 4902 ), 4903 'defaultProps' => $props, 4904 'attachmentCounts' => array( 4905 'audio' => ( $show_audio_playlist ) ? 1 : 0, 4906 'video' => ( $show_video_playlist ) ? 1 : 0, 4907 ), 4908 'oEmbedProxyUrl' => rest_url( 'oembed/1.0/proxy' ), 4909 'embedExts' => $exts, 4910 'embedMimes' => $ext_mimes, 4911 'contentWidth' => $content_width, 4912 'months' => $months, 4913 'mediaTrash' => MEDIA_TRASH ? 1 : 0, 4914 'infiniteScrolling' => ( $infinite_scrolling ) ? 1 : 0, 4915 ); 4916 4917 $post = null; 4918 if ( isset( $args['post'] ) ) { 4919 $post = get_post( $args['post'] ); 4920 $settings['post'] = array( 4921 'id' => $post->ID, 4922 'nonce' => wp_create_nonce( 'update-post_' . $post->ID ), 4923 ); 4924 4925 $thumbnail_support = current_theme_supports( 'post-thumbnails', $post->post_type ) && post_type_supports( $post->post_type, 'thumbnail' ); 4926 if ( ! $thumbnail_support && 'attachment' === $post->post_type && $post->post_mime_type ) { 4927 if ( wp_attachment_is( 'audio', $post ) ) { 4928 $thumbnail_support = post_type_supports( 'attachment:audio', 'thumbnail' ) || current_theme_supports( 'post-thumbnails', 'attachment:audio' ); 4929 } elseif ( wp_attachment_is( 'video', $post ) ) { 4930 $thumbnail_support = post_type_supports( 'attachment:video', 'thumbnail' ) || current_theme_supports( 'post-thumbnails', 'attachment:video' ); 4931 } 4932 } 4933 4934 if ( $thumbnail_support ) { 4935 $featured_image_id = get_post_meta( $post->ID, '_thumbnail_id', true ); 4936 $settings['post']['featuredImageId'] = $featured_image_id ? $featured_image_id : -1; 4937 } 4938 } 4939 4940 if ( $post ) { 4941 $post_type_object = get_post_type_object( $post->post_type ); 4942 } else { 4943 $post_type_object = get_post_type_object( 'post' ); 4944 } 4945 4946 $strings = array( 4947 // Generic. 4948 'mediaFrameDefaultTitle' => __( 'Media' ), 4949 'url' => __( 'URL' ), 4950 'addMedia' => __( 'Add media' ), 4951 'search' => __( 'Search' ), 4952 'select' => __( 'Select' ), 4953 'cancel' => __( 'Cancel' ), 4954 'update' => __( 'Update' ), 4955 'replace' => __( 'Replace' ), 4956 'remove' => __( 'Remove' ), 4957 'back' => __( 'Back' ), 4958 /* 4959 * translators: This is a would-be plural string used in the media manager. 4960 * If there is not a word you can use in your language to avoid issues with the 4961 * lack of plural support here, turn it into "selected: %d" then translate it. 4962 */ 4963 'selected' => __( '%d selected' ), 4964 'dragInfo' => __( 'Drag and drop to reorder media files.' ), 4965 4966 // Upload. 4967 'uploadFilesTitle' => __( 'Upload files' ), 4968 'uploadImagesTitle' => __( 'Upload images' ), 4969 4970 // Library. 4971 'mediaLibraryTitle' => __( 'Media Library' ), 4972 'insertMediaTitle' => __( 'Add media' ), 4973 'createNewGallery' => __( 'Create a new gallery' ), 4974 'createNewPlaylist' => __( 'Create a new playlist' ), 4975 'createNewVideoPlaylist' => __( 'Create a new video playlist' ), 4976 'returnToLibrary' => __( '← Go to library' ), 4977 'allMediaItems' => __( 'All media items' ), 4978 'allDates' => __( 'All dates' ), 4979 'noItemsFound' => __( 'No items found.' ), 4980 'insertIntoPost' => $post_type_object->labels->insert_into_item, 4981 'unattached' => _x( 'Unattached', 'media items' ), 4982 'mine' => _x( 'Mine', 'media items' ), 4983 'trash' => _x( 'Trash', 'noun' ), 4984 'uploadedToThisPost' => $post_type_object->labels->uploaded_to_this_item, 4985 'warnDelete' => __( "You are about to permanently delete this item from your site.\nThis action cannot be undone.\n 'Cancel' to stop, 'OK' to delete." ), 4986 'warnBulkDelete' => __( "You are about to permanently delete these items from your site.\nThis action cannot be undone.\n 'Cancel' to stop, 'OK' to delete." ), 4987 'warnBulkTrash' => __( "You are about to trash these items.\n 'Cancel' to stop, 'OK' to delete." ), 4988 'bulkSelect' => __( 'Bulk select' ), 4989 'trashSelected' => __( 'Move to Trash' ), 4990 'restoreSelected' => __( 'Restore from Trash' ), 4991 'deletePermanently' => __( 'Delete permanently' ), 4992 'errorDeleting' => __( 'Error in deleting the attachment.' ), 4993 'apply' => __( 'Apply' ), 4994 'filterByDate' => __( 'Filter by date' ), 4995 'filterByType' => __( 'Filter by type' ), 4996 'searchLabel' => __( 'Search media' ), 4997 'searchMediaLabel' => __( 'Search media' ), // Backward compatibility pre-5.3. 4998 'searchMediaPlaceholder' => __( 'Search media items...' ), // Placeholder (no ellipsis), backward compatibility pre-5.3. 4999 /* translators: %d: Number of attachments found in a search. */ 5000 'mediaFound' => __( 'Number of media items found: %d' ), 5001 'noMedia' => __( 'No media items found.' ), 5002 'noMediaTryNewSearch' => __( 'No media items found. Try a different search.' ), 5003 5004 // Library Details. 5005 'attachmentDetails' => __( 'Attachment details' ), 5006 5007 // From URL. 5008 'insertFromUrlTitle' => __( 'Insert from URL' ), 5009 5010 // Featured Images. 5011 'setFeaturedImageTitle' => $post_type_object->labels->featured_image, 5012 'setFeaturedImage' => $post_type_object->labels->set_featured_image, 5013 5014 // Gallery. 5015 'createGalleryTitle' => __( 'Create gallery' ), 5016 'editGalleryTitle' => __( 'Edit gallery' ), 5017 'cancelGalleryTitle' => __( '← Cancel gallery' ), 5018 'insertGallery' => __( 'Insert gallery' ), 5019 'updateGallery' => __( 'Update gallery' ), 5020 'addToGallery' => __( 'Add to gallery' ), 5021 'addToGalleryTitle' => __( 'Add to gallery' ), 5022 'reverseOrder' => __( 'Reverse order' ), 5023 5024 // Edit Image. 5025 'imageDetailsTitle' => __( 'Image details' ), 5026 'imageReplaceTitle' => __( 'Replace image' ), 5027 'imageDetailsCancel' => __( 'Cancel edit' ), 5028 'editImage' => __( 'Edit image' ), 5029 5030 // Crop Image. 5031 'chooseImage' => __( 'Choose image' ), 5032 'selectAndCrop' => __( 'Select and crop' ), 5033 'skipCropping' => __( 'Skip cropping' ), 5034 'cropImage' => __( 'Crop image' ), 5035 'cropYourImage' => __( 'Crop your image' ), 5036 'cropping' => __( 'Cropping…' ), 5037 /* translators: 1: Suggested width number, 2: Suggested height number. */ 5038 'suggestedDimensions' => __( 'Suggested image dimensions: %1$s by %2$s pixels.' ), 5039 'cropError' => __( 'There has been an error cropping your image.' ), 5040 5041 // Edit Audio. 5042 'audioDetailsTitle' => __( 'Audio details' ), 5043 'audioReplaceTitle' => __( 'Replace audio' ), 5044 'audioAddSourceTitle' => __( 'Add audio source' ), 5045 'audioDetailsCancel' => __( 'Cancel edit' ), 5046 5047 // Edit Video. 5048 'videoDetailsTitle' => __( 'Video details' ), 5049 'videoReplaceTitle' => __( 'Replace video' ), 5050 'videoAddSourceTitle' => __( 'Add video source' ), 5051 'videoDetailsCancel' => __( 'Cancel edit' ), 5052 'videoSelectPosterImageTitle' => __( 'Select poster image' ), 5053 'videoAddTrackTitle' => __( 'Add subtitles' ), 5054 5055 // Playlist. 5056 'playlistDragInfo' => __( 'Drag and drop to reorder tracks.' ), 5057 'createPlaylistTitle' => __( 'Create audio playlist' ), 5058 'editPlaylistTitle' => __( 'Edit audio playlist' ), 5059 'cancelPlaylistTitle' => __( '← Cancel audio playlist' ), 5060 'insertPlaylist' => __( 'Insert audio playlist' ), 5061 'updatePlaylist' => __( 'Update audio playlist' ), 5062 'addToPlaylist' => __( 'Add to audio playlist' ), 5063 'addToPlaylistTitle' => __( 'Add to Audio Playlist' ), 5064 5065 // Video Playlist. 5066 'videoPlaylistDragInfo' => __( 'Drag and drop to reorder videos.' ), 5067 'createVideoPlaylistTitle' => __( 'Create video playlist' ), 5068 'editVideoPlaylistTitle' => __( 'Edit video playlist' ), 5069 'cancelVideoPlaylistTitle' => __( '← Cancel video playlist' ), 5070 'insertVideoPlaylist' => __( 'Insert video playlist' ), 5071 'updateVideoPlaylist' => __( 'Update video playlist' ), 5072 'addToVideoPlaylist' => __( 'Add to video playlist' ), 5073 'addToVideoPlaylistTitle' => __( 'Add to video Playlist' ), 5074 5075 // Headings. 5076 'filterAttachments' => __( 'Filter media' ), 5077 'attachmentsList' => __( 'Media list' ), 5078 ); 5079 5080 /** 5081 * Filters the media view settings. 5082 * 5083 * @since 3.5.0 5084 * 5085 * @param array $settings List of media view settings. 5086 * @param WP_Post $post Post object. 5087 */ 5088 $settings = apply_filters( 'media_view_settings', $settings, $post ); 5089 5090 /** 5091 * Filters the media view strings. 5092 * 5093 * @since 3.5.0 5094 * 5095 * @param string[] $strings Array of media view strings keyed by the name they'll be referenced by in JavaScript. 5096 * @param WP_Post $post Post object. 5097 */ 5098 $strings = apply_filters( 'media_view_strings', $strings, $post ); 5099 5100 $strings['settings'] = $settings; 5101 5102 /* 5103 * Ensure we enqueue media-editor first, that way media-views 5104 * is registered internally before we try to localize it. See #24724. 5105 */ 5106 wp_enqueue_script( 'media-editor' ); 5107 wp_localize_script( 'media-views', '_wpMediaViewsL10n', $strings ); 5108 5109 wp_enqueue_script( 'media-audiovideo' ); 5110 wp_enqueue_style( 'media-views' ); 5111 if ( is_admin() ) { 5112 wp_enqueue_script( 'mce-view' ); 5113 wp_enqueue_script( 'image-edit' ); 5114 } 5115 wp_enqueue_style( 'imgareaselect' ); 5116 wp_plupload_default_settings(); 5117 5118 require_once ABSPATH . WPINC . '/media-template.php'; 5119 add_action( 'admin_footer', 'wp_print_media_templates' ); 5120 add_action( 'wp_footer', 'wp_print_media_templates' ); 5121 add_action( 'customize_controls_print_footer_scripts', 'wp_print_media_templates' ); 5122 5123 /** 5124 * Fires at the conclusion of wp_enqueue_media(). 5125 * 5126 * @since 3.5.0 5127 */ 5128 do_action( 'wp_enqueue_media' ); 5129 } 5130 5131 /** 5132 * Retrieves media attached to the passed post. 5133 * 5134 * @since 3.6.0 5135 * 5136 * @param string $type Mime type. 5137 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. 5138 * @return WP_Post[] Array of media attached to the given post. 5139 */ 5140 function get_attached_media( $type, $post = 0 ) { 5141 $post = get_post( $post ); 5142 5143 if ( ! $post ) { 5144 return array(); 5145 } 5146 5147 $args = array( 5148 'post_parent' => $post->ID, 5149 'post_type' => 'attachment', 5150 'post_mime_type' => $type, 5151 'posts_per_page' => -1, 5152 'orderby' => 'menu_order', 5153 'order' => 'ASC', 5154 ); 5155 5156 /** 5157 * Filters arguments used to retrieve media attached to the given post. 5158 * 5159 * @since 3.6.0 5160 * 5161 * @param array $args Post query arguments. 5162 * @param string $type Mime type of the desired media. 5163 * @param WP_Post $post Post object. 5164 */ 5165 $args = apply_filters( 'get_attached_media_args', $args, $type, $post ); 5166 5167 $children = get_children( $args ); 5168 5169 /** 5170 * Filters the list of media attached to the given post. 5171 * 5172 * @since 3.6.0 5173 * 5174 * @param WP_Post[] $children Array of media attached to the given post. 5175 * @param string $type Mime type of the media desired. 5176 * @param WP_Post $post Post object. 5177 */ 5178 return (array) apply_filters( 'get_attached_media', $children, $type, $post ); 5179 } 5180 5181 /** 5182 * Checks the HTML content for an audio, video, object, embed, or iframe tags. 5183 * 5184 * @since 3.6.0 5185 * 5186 * @param string $content A string of HTML which might contain media elements. 5187 * @param string[] $types An array of media types: 'audio', 'video', 'object', 'embed', or 'iframe'. 5188 * @return string[] Array of found HTML media elements. 5189 */ 5190 function get_media_embedded_in_content( $content, $types = null ) { 5191 $html = array(); 5192 5193 /** 5194 * Filters the embedded media types that are allowed to be returned from the content blob. 5195 * 5196 * @since 4.2.0 5197 * 5198 * @param string[] $allowed_media_types An array of allowed media types. Default media types are 5199 * 'audio', 'video', 'object', 'embed', and 'iframe'. 5200 */ 5201 $allowed_media_types = apply_filters( 'media_embedded_in_content_allowed_types', array( 'audio', 'video', 'object', 'embed', 'iframe' ) ); 5202 5203 if ( ! empty( $types ) ) { 5204 if ( ! is_array( $types ) ) { 5205 $types = array( $types ); 5206 } 5207 5208 $allowed_media_types = array_intersect( $allowed_media_types, $types ); 5209 } 5210 5211 $tags = implode( '|', $allowed_media_types ); 5212 5213 if ( preg_match_all( '#<(?P<tag>' . $tags . ')[^<]*?(?:>[\s\S]*?<\/(?P=tag)>|\s*\/>)#', $content, $matches ) ) { 5214 foreach ( $matches[0] as $match ) { 5215 $html[] = $match; 5216 } 5217 } 5218 5219 return $html; 5220 } 5221 5222 /** 5223 * Retrieves galleries from the passed post's content. 5224 * 5225 * @since 3.6.0 5226 * 5227 * @param int|WP_Post $post Post ID or object. 5228 * @param bool $html Optional. Whether to return HTML or data in the array. Default true. 5229 * @return array A list of arrays, each containing gallery data and srcs parsed 5230 * from the expanded shortcode. 5231 */ 5232 function get_post_galleries( $post, $html = true ) { 5233 $post = get_post( $post ); 5234 5235 if ( ! $post ) { 5236 return array(); 5237 } 5238 5239 if ( ! has_shortcode( $post->post_content, 'gallery' ) && ! has_block( 'gallery', $post->post_content ) ) { 5240 return array(); 5241 } 5242 5243 $galleries = array(); 5244 if ( preg_match_all( '/' . get_shortcode_regex() . '/s', $post->post_content, $matches, PREG_SET_ORDER ) ) { 5245 foreach ( $matches as $shortcode ) { 5246 if ( 'gallery' === $shortcode[2] ) { 5247 $srcs = array(); 5248 5249 $shortcode_attrs = shortcode_parse_atts( $shortcode[3] ); 5250 5251 // Specify the post ID of the gallery we're viewing if the shortcode doesn't reference another post already. 5252 if ( ! isset( $shortcode_attrs['id'] ) ) { 5253 $shortcode[3] .= ' id="' . (int) $post->ID . '"'; 5254 } 5255 5256 $gallery = do_shortcode_tag( $shortcode ); 5257 if ( $html ) { 5258 $galleries[] = $gallery; 5259 } else { 5260 preg_match_all( '#src=([\'"])(.+?)\1#is', $gallery, $src, PREG_SET_ORDER ); 5261 if ( ! empty( $src ) ) { 5262 foreach ( $src as $s ) { 5263 $srcs[] = $s[2]; 5264 } 5265 } 5266 5267 $galleries[] = array_merge( 5268 $shortcode_attrs, 5269 array( 5270 'src' => array_values( array_unique( $srcs ) ), 5271 ) 5272 ); 5273 } 5274 } 5275 } 5276 } 5277 5278 if ( has_block( 'gallery', $post->post_content ) ) { 5279 $post_blocks = parse_blocks( $post->post_content ); 5280 5281 while ( $block = array_shift( $post_blocks ) ) { 5282 $has_inner_blocks = ! empty( $block['innerBlocks'] ); 5283 5284 // Skip blocks with no blockName and no innerHTML. 5285 if ( ! $block['blockName'] ) { 5286 continue; 5287 } 5288 5289 // Skip non-Gallery blocks. 5290 if ( 'core/gallery' !== $block['blockName'] ) { 5291 // Move inner blocks into the root array before skipping. 5292 if ( $has_inner_blocks ) { 5293 array_push( $post_blocks, ...$block['innerBlocks'] ); 5294 } 5295 continue; 5296 } 5297 5298 // New Gallery block format as HTML. 5299 if ( $has_inner_blocks && $html ) { 5300 $block_html = wp_list_pluck( $block['innerBlocks'], 'innerHTML' ); 5301 $galleries[] = '<figure>' . implode( ' ', $block_html ) . '</figure>'; 5302 continue; 5303 } 5304 5305 $srcs = array(); 5306 5307 // New Gallery block format as an array. 5308 if ( $has_inner_blocks ) { 5309 $attrs = wp_list_pluck( $block['innerBlocks'], 'attrs' ); 5310 $ids = wp_list_pluck( $attrs, 'id' ); 5311 5312 foreach ( $ids as $id ) { 5313 $url = wp_get_attachment_url( $id ); 5314 5315 if ( is_string( $url ) && ! in_array( $url, $srcs, true ) ) { 5316 $srcs[] = $url; 5317 } 5318 } 5319 5320 $galleries[] = array( 5321 'ids' => implode( ',', $ids ), 5322 'src' => $srcs, 5323 ); 5324 5325 continue; 5326 } 5327 5328 // Old Gallery block format as HTML. 5329 if ( $html ) { 5330 $galleries[] = $block['innerHTML']; 5331 continue; 5332 } 5333 5334 // Old Gallery block format as an array. 5335 $ids = ! empty( $block['attrs']['ids'] ) ? $block['attrs']['ids'] : array(); 5336 5337 // If present, use the image IDs from the JSON blob as canonical. 5338 if ( ! empty( $ids ) ) { 5339 foreach ( $ids as $id ) { 5340 $url = wp_get_attachment_url( $id ); 5341 5342 if ( is_string( $url ) && ! in_array( $url, $srcs, true ) ) { 5343 $srcs[] = $url; 5344 } 5345 } 5346 5347 $galleries[] = array( 5348 'ids' => implode( ',', $ids ), 5349 'src' => $srcs, 5350 ); 5351 5352 continue; 5353 } 5354 5355 // Otherwise, extract srcs from the innerHTML. 5356 preg_match_all( '#src=([\'"])(.+?)\1#is', $block['innerHTML'], $found_srcs, PREG_SET_ORDER ); 5357 5358 if ( ! empty( $found_srcs[0] ) ) { 5359 foreach ( $found_srcs as $src ) { 5360 if ( isset( $src[2] ) && ! in_array( $src[2], $srcs, true ) ) { 5361 $srcs[] = $src[2]; 5362 } 5363 } 5364 } 5365 5366 $galleries[] = array( 'src' => $srcs ); 5367 } 5368 } 5369 5370 /** 5371 * Filters the list of all found galleries in the given post. 5372 * 5373 * @since 3.6.0 5374 * 5375 * @param array $galleries Associative array of all found post galleries. 5376 * @param WP_Post $post Post object. 5377 */ 5378 return apply_filters( 'get_post_galleries', $galleries, $post ); 5379 } 5380 5381 /** 5382 * Checks a specified post's content for gallery and, if present, return the first 5383 * 5384 * @since 3.6.0 5385 * 5386 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. 5387 * @param bool $html Optional. Whether to return HTML or data. Default is true. 5388 * @return string|array Gallery data and srcs parsed from the expanded shortcode. 5389 */ 5390 function get_post_gallery( $post = 0, $html = true ) { 5391 $galleries = get_post_galleries( $post, $html ); 5392 $gallery = reset( $galleries ); 5393 5394 /** 5395 * Filters the first-found post gallery. 5396 * 5397 * @since 3.6.0 5398 * 5399 * @param array $gallery The first-found post gallery. 5400 * @param int|WP_Post $post Post ID or object. 5401 * @param array $galleries Associative array of all found post galleries. 5402 */ 5403 return apply_filters( 'get_post_gallery', $gallery, $post, $galleries ); 5404 } 5405 5406 /** 5407 * Retrieves the image srcs from galleries from a post's content, if present. 5408 * 5409 * @since 3.6.0 5410 * 5411 * @see get_post_galleries() 5412 * 5413 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. 5414 * @return array A list of lists, each containing image srcs parsed. 5415 * from an expanded shortcode 5416 */ 5417 function get_post_galleries_images( $post = 0 ) { 5418 $galleries = get_post_galleries( $post, false ); 5419 return wp_list_pluck( $galleries, 'src' ); 5420 } 5421 5422 /** 5423 * Checks a post's content for galleries and return the image srcs for the first found gallery. 5424 * 5425 * @since 3.6.0 5426 * 5427 * @see get_post_gallery() 5428 * 5429 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`. 5430 * @return string[] A list of a gallery's image srcs in order. 5431 */ 5432 function get_post_gallery_images( $post = 0 ) { 5433 $gallery = get_post_gallery( $post, false ); 5434 return empty( $gallery['src'] ) ? array() : $gallery['src']; 5435 } 5436 5437 /** 5438 * Maybe attempts to generate attachment metadata, if missing. 5439 * 5440 * @since 3.9.0 5441 * 5442 * @param WP_Post $attachment Attachment object. 5443 */ 5444 function wp_maybe_generate_attachment_metadata( $attachment ) { 5445 if ( empty( $attachment ) || empty( $attachment->ID ) ) { 5446 return; 5447 } 5448 5449 $attachment_id = (int) $attachment->ID; 5450 $file = get_attached_file( $attachment_id ); 5451 $meta = wp_get_attachment_metadata( $attachment_id ); 5452 5453 if ( empty( $meta ) && file_exists( $file ) ) { 5454 $_meta = get_post_meta( $attachment_id ); 5455 $_lock = 'wp_generating_att_' . $attachment_id; 5456 5457 if ( ! array_key_exists( '_wp_attachment_metadata', $_meta ) && ! get_transient( $_lock ) ) { 5458 set_transient( $_lock, $file ); 5459 wp_update_attachment_metadata( $attachment_id, wp_generate_attachment_metadata( $attachment_id, $file ) ); 5460 delete_transient( $_lock ); 5461 } 5462 } 5463 } 5464 5465 /** 5466 * Tries to convert an attachment URL into a post ID. 5467 * 5468 * @since 4.0.0 5469 * 5470 * @global wpdb $wpdb WordPress database abstraction object. 5471 * 5472 * @param string $url The URL to resolve. 5473 * @return int The found post ID, or 0 on failure. 5474 */ 5475 function attachment_url_to_postid( $url ) { 5476 global $wpdb; 5477 5478 /** 5479 * Filters the attachment ID to allow short-circuit the function. 5480 * 5481 * Allows plugins to short-circuit attachment ID lookups. Plugins making 5482 * use of this function should return: 5483 * 5484 * - 0 (integer) to indicate the attachment is not found, 5485 * - attachment ID (integer) to indicate the attachment ID found, 5486 * - null to indicate WordPress should proceed with the lookup. 5487 * 5488 * Warning: The post ID may be null or zero, both of which cast to a 5489 * boolean false. For information about casting to booleans see the 5490 * {@link https://www.php.net/manual/en/language.types.boolean.php PHP documentation}. 5491 * Use the === operator for testing the post ID when developing filters using 5492 * this hook. 5493 * 5494 * @since 6.7.0 5495 * 5496 * @param int|null $post_id The result of the post ID lookup. Null to indicate 5497 * no lookup has been attempted. Default null. 5498 * @param string $url The URL being looked up. 5499 */ 5500 $post_id = apply_filters( 'pre_attachment_url_to_postid', null, $url ); 5501 if ( null !== $post_id ) { 5502 return (int) $post_id; 5503 } 5504 5505 $dir = wp_get_upload_dir(); 5506 $path = $url; 5507 5508 $site_url = parse_url( $dir['url'] ); 5509 $image_path = parse_url( $path ); 5510 5511 // Force the protocols to match if needed. 5512 if ( isset( $image_path['scheme'] ) && ( $image_path['scheme'] !== $site_url['scheme'] ) ) { 5513 $path = str_replace( $image_path['scheme'], $site_url['scheme'], $path ); 5514 } 5515 5516 if ( str_starts_with( $path, $dir['baseurl'] . '/' ) ) { 5517 $path = substr( $path, strlen( $dir['baseurl'] . '/' ) ); 5518 } 5519 5520 $sql = $wpdb->prepare( 5521 "SELECT post_id, meta_value FROM $wpdb->postmeta WHERE meta_key = '_wp_attached_file' AND meta_value = %s", 5522 $path 5523 ); 5524 5525 $results = $wpdb->get_results( $sql ); 5526 $post_id = null; 5527 5528 if ( $results ) { 5529 // Use the first available result, but prefer a case-sensitive match, if exists. 5530 $post_id = reset( $results )->post_id; 5531 5532 if ( count( $results ) > 1 ) { 5533 foreach ( $results as $result ) { 5534 if ( $path === $result->meta_value ) { 5535 $post_id = $result->post_id; 5536 break; 5537 } 5538 } 5539 } 5540 } 5541 5542 /** 5543 * Filters an attachment ID found by URL. 5544 * 5545 * @since 4.2.0 5546 * 5547 * @param int|null $post_id The post_id (if any) found by the function. 5548 * @param string $url The URL being looked up. 5549 */ 5550 return (int) apply_filters( 'attachment_url_to_postid', $post_id, $url ); 5551 } 5552 5553 /** 5554 * Returns the URLs for CSS files used in an iframe-sandbox'd TinyMCE media view. 5555 * 5556 * @since 4.0.0 5557 * 5558 * @return string[] The relevant CSS file URLs. 5559 */ 5560 function wpview_media_sandbox_styles() { 5561 $version = 'ver=' . get_bloginfo( 'version' ); 5562 $mediaelement = includes_url( "js/mediaelement/mediaelementplayer-legacy.min.css?$version" ); 5563 $wpmediaelement = includes_url( "js/mediaelement/wp-mediaelement.css?$version" ); 5564 5565 return array( $mediaelement, $wpmediaelement ); 5566 } 5567 5568 /** 5569 * Registers the personal data exporter for media. 5570 * 5571 * @since 4.9.6 5572 * 5573 * @param array[] $exporters An array of personal data exporters, keyed by their ID. 5574 * @return array[] Updated array of personal data exporters. 5575 */ 5576 function wp_register_media_personal_data_exporter( $exporters ) { 5577 $exporters['wordpress-media'] = array( 5578 'exporter_friendly_name' => __( 'WordPress Media' ), 5579 'callback' => 'wp_media_personal_data_exporter', 5580 ); 5581 5582 return $exporters; 5583 } 5584 5585 /** 5586 * Finds and exports attachments associated with an email address. 5587 * 5588 * @since 4.9.6 5589 * 5590 * @param string $email_address The attachment owner email address. 5591 * @param int $page Attachment page number. 5592 * @return array { 5593 * An array of personal data. 5594 * 5595 * @type array[] $data An array of personal data arrays. 5596 * @type bool $done Whether the exporter is finished. 5597 * } 5598 */ 5599 function wp_media_personal_data_exporter( $email_address, $page = 1 ) { 5600 // Limit us to 50 attachments at a time to avoid timing out. 5601 $number = 50; 5602 $page = (int) $page; 5603 5604 $data_to_export = array(); 5605 5606 $user = get_user_by( 'email', $email_address ); 5607 if ( false === $user ) { 5608 return array( 5609 'data' => $data_to_export, 5610 'done' => true, 5611 ); 5612 } 5613 5614 $post_query = new WP_Query( 5615 array( 5616 'author' => $user->ID, 5617 'posts_per_page' => $number, 5618 'paged' => $page, 5619 'post_type' => 'attachment', 5620 'post_status' => 'any', 5621 'orderby' => 'ID', 5622 'order' => 'ASC', 5623 ) 5624 ); 5625 5626 foreach ( (array) $post_query->posts as $post ) { 5627 $attachment_url = wp_get_attachment_url( $post->ID ); 5628 5629 if ( $attachment_url ) { 5630 $post_data_to_export = array( 5631 array( 5632 'name' => __( 'URL' ), 5633 'value' => $attachment_url, 5634 ), 5635 ); 5636 5637 $data_to_export[] = array( 5638 'group_id' => 'media', 5639 'group_label' => __( 'Media' ), 5640 'group_description' => __( 'User’s media data.' ), 5641 'item_id' => "post-{$post->ID}", 5642 'data' => $post_data_to_export, 5643 ); 5644 } 5645 } 5646 5647 $done = $post_query->max_num_pages <= $page; 5648 5649 return array( 5650 'data' => $data_to_export, 5651 'done' => $done, 5652 ); 5653 } 5654 5655 /** 5656 * Adds additional default image sub-sizes. 5657 * 5658 * These sizes are meant to enhance the way WordPress displays images on the front-end on larger, 5659 * high-density devices. They make it possible to generate more suitable `srcset` and `sizes` attributes 5660 * when the users upload large images. 5661 * 5662 * The sizes can be changed or removed by themes and plugins but that is not recommended. 5663 * The size "names" reflect the image dimensions, so changing the sizes would be quite misleading. 5664 * 5665 * @since 5.3.0 5666 * @access private 5667 */ 5668 function _wp_add_additional_image_sizes() { 5669 // 2x medium_large size. 5670 add_image_size( '1536x1536', 1536, 1536 ); 5671 // 2x large size. 5672 add_image_size( '2048x2048', 2048, 2048 ); 5673 } 5674 5675 /** 5676 * Callback to enable showing of the user error when uploading .heic images. 5677 * 5678 * @since 5.5.0 5679 * @since 6.7.0 The default behavior is to enable heic uploads as long as the server 5680 * supports the format. The uploads are converted to JPEG's by default. 5681 * 5682 * @param array[] $plupload_settings The settings for Plupload.js. 5683 * @return array[] Modified settings for Plupload.js. 5684 */ 5685 function wp_show_heic_upload_error( $plupload_settings ) { 5686 // Check if HEIC images can be edited. 5687 if ( ! wp_image_editor_supports( array( 'mime_type' => 'image/heic' ) ) ) { 5688 $plupload_init['heic_upload_error'] = true; 5689 } 5690 return $plupload_settings; 5691 } 5692 5693 /** 5694 * Allows PHP's getimagesize() to be debuggable when necessary. 5695 * 5696 * @since 5.7.0 5697 * @since 5.8.0 Added support for WebP images. 5698 * @since 6.5.0 Added support for AVIF images. 5699 * 5700 * @param string $filename The file path. 5701 * @param array $image_info Optional. Extended image information (passed by reference). 5702 * @return array|false Array of image information or false on failure. 5703 */ 5704 function wp_getimagesize( $filename, ?array &$image_info = null ) { 5705 // Don't silence errors when in debug mode, unless running unit tests. 5706 if ( defined( 'WP_DEBUG' ) && WP_DEBUG && ! defined( 'WP_RUN_CORE_TESTS' ) ) { 5707 if ( 2 === func_num_args() ) { 5708 $info = getimagesize( $filename, $image_info ); 5709 } else { 5710 $info = getimagesize( $filename ); 5711 } 5712 } else { 5713 /* 5714 * Silencing notice and warning is intentional. 5715 * 5716 * getimagesize() has a tendency to generate errors, such as 5717 * "corrupt JPEG data: 7191 extraneous bytes before marker", 5718 * even when it's able to provide image size information. 5719 * 5720 * See https://core.trac.wordpress.org/ticket/42480 5721 */ 5722 if ( 2 === func_num_args() ) { 5723 $info = @getimagesize( $filename, $image_info ); 5724 } else { 5725 $info = @getimagesize( $filename ); 5726 } 5727 } 5728 5729 if ( 5730 ! empty( $info ) && 5731 // Some PHP versions return 0x0 sizes from `getimagesize` for unrecognized image formats, including AVIFs. 5732 ! ( empty( $info[0] ) && empty( $info[1] ) ) 5733 ) { 5734 return $info; 5735 } 5736 5737 $image_mime_type = wp_get_image_mime( $filename ); 5738 5739 // Not an image? 5740 if ( false === $image_mime_type ) { 5741 return false; 5742 } 5743 5744 /* 5745 * For PHP versions that don't support WebP images, 5746 * extract the image size info from the file headers. 5747 */ 5748 if ( 'image/webp' === $image_mime_type ) { 5749 $webp_info = wp_get_webp_info( $filename ); 5750 $width = $webp_info['width']; 5751 $height = $webp_info['height']; 5752 5753 // Mimic the native return format. 5754 if ( $width && $height ) { 5755 return array( 5756 $width, 5757 $height, 5758 IMAGETYPE_WEBP, 5759 sprintf( 5760 'width="%d" height="%d"', 5761 $width, 5762 $height 5763 ), 5764 'mime' => 'image/webp', 5765 ); 5766 } 5767 } 5768 5769 // For PHP versions that don't support AVIF images, extract the image size info from the file headers. 5770 if ( 'image/avif' === $image_mime_type ) { 5771 $avif_info = wp_get_avif_info( $filename ); 5772 5773 $width = $avif_info['width']; 5774 $height = $avif_info['height']; 5775 5776 // Mimic the native return format. 5777 if ( $width && $height ) { 5778 return array( 5779 $width, 5780 $height, 5781 IMAGETYPE_AVIF, 5782 sprintf( 5783 'width="%d" height="%d"', 5784 $width, 5785 $height 5786 ), 5787 'mime' => 'image/avif', 5788 ); 5789 } 5790 } 5791 5792 // For PHP versions that don't support HEIC images, extract the size info using Imagick when available. 5793 if ( wp_is_heic_image_mime_type( $image_mime_type ) ) { 5794 $editor = wp_get_image_editor( $filename ); 5795 5796 if ( is_wp_error( $editor ) ) { 5797 return false; 5798 } 5799 5800 // If the editor for HEICs is Imagick, use it to get the image size. 5801 if ( $editor instanceof WP_Image_Editor_Imagick ) { 5802 $size = $editor->get_size(); 5803 return array( 5804 $size['width'], 5805 $size['height'], 5806 IMAGETYPE_HEIC, 5807 sprintf( 5808 'width="%d" height="%d"', 5809 $size['width'], 5810 $size['height'] 5811 ), 5812 'mime' => 'image/heic', 5813 ); 5814 } 5815 } 5816 5817 // The image could not be parsed. 5818 return false; 5819 } 5820 5821 /** 5822 * Extracts meta information about an AVIF file: width, height, bit depth, and number of channels. 5823 * 5824 * @since 6.5.0 5825 * 5826 * @param string $filename Path to an AVIF file. 5827 * @return array { 5828 * An array of AVIF image information. 5829 * 5830 * @type int|false $width Image width on success, false on failure. 5831 * @type int|false $height Image height on success, false on failure. 5832 * @type int|false $bit_depth Image bit depth on success, false on failure. 5833 * @type int|false $num_channels Image number of channels on success, false on failure. 5834 * } 5835 */ 5836 function wp_get_avif_info( $filename ) { 5837 $results = array( 5838 'width' => false, 5839 'height' => false, 5840 'bit_depth' => false, 5841 'num_channels' => false, 5842 ); 5843 5844 if ( 'image/avif' !== wp_get_image_mime( $filename ) ) { 5845 return $results; 5846 } 5847 5848 // Parse the file using libavifinfo's PHP implementation. 5849 require_once ABSPATH . WPINC . '/class-avif-info.php'; 5850 5851 $handle = fopen( $filename, 'rb' ); 5852 if ( $handle ) { 5853 $parser = new Avifinfo\Parser( $handle ); 5854 $success = $parser->parse_ftyp() && $parser->parse_file(); 5855 fclose( $handle ); 5856 if ( $success ) { 5857 $results = $parser->features->primary_item_features; 5858 } 5859 } 5860 return $results; 5861 } 5862 5863 /** 5864 * Extracts meta information about a WebP file: width, height, and type. 5865 * 5866 * @since 5.8.0 5867 * 5868 * @param string $filename Path to a WebP file. 5869 * @return array { 5870 * An array of WebP image information. 5871 * 5872 * @type int|false $width Image width on success, false on failure. 5873 * @type int|false $height Image height on success, false on failure. 5874 * @type string|false $type The WebP type: one of 'lossy', 'lossless' or 'animated-alpha'. 5875 * False on failure. 5876 * } 5877 */ 5878 function wp_get_webp_info( $filename ) { 5879 $width = false; 5880 $height = false; 5881 $type = false; 5882 5883 if ( 'image/webp' !== wp_get_image_mime( $filename ) ) { 5884 return compact( 'width', 'height', 'type' ); 5885 } 5886 5887 $magic = file_get_contents( $filename, false, null, 0, 40 ); 5888 5889 if ( false === $magic ) { 5890 return compact( 'width', 'height', 'type' ); 5891 } 5892 5893 // Make sure we got enough bytes. 5894 if ( strlen( $magic ) < 40 ) { 5895 return compact( 'width', 'height', 'type' ); 5896 } 5897 5898 /* 5899 * The headers are a little different for each of the three formats. 5900 * Header values based on WebP docs, see https://developers.google.com/speed/webp/docs/riff_container. 5901 */ 5902 switch ( substr( $magic, 12, 4 ) ) { 5903 // Lossy WebP. 5904 case 'VP8 ': 5905 $parts = unpack( 'v2', substr( $magic, 26, 4 ) ); 5906 $width = (int) ( $parts[1] & 0x3FFF ); 5907 $height = (int) ( $parts[2] & 0x3FFF ); 5908 $type = 'lossy'; 5909 break; 5910 // Lossless WebP. 5911 case 'VP8L': 5912 $parts = unpack( 'C4', substr( $magic, 21, 4 ) ); 5913 $width = (int) ( $parts[1] | ( ( $parts[2] & 0x3F ) << 8 ) ) + 1; 5914 $height = (int) ( ( ( $parts[2] & 0xC0 ) >> 6 ) | ( $parts[3] << 2 ) | ( ( $parts[4] & 0x03 ) << 10 ) ) + 1; 5915 $type = 'lossless'; 5916 break; 5917 // Animated/alpha WebP. 5918 case 'VP8X': 5919 // Pad 24-bit int. 5920 $width = unpack( 'V', substr( $magic, 24, 3 ) . "\x00" ); 5921 $width = (int) ( $width[1] & 0xFFFFFF ) + 1; 5922 // Pad 24-bit int. 5923 $height = unpack( 'V', substr( $magic, 27, 3 ) . "\x00" ); 5924 $height = (int) ( $height[1] & 0xFFFFFF ) + 1; 5925 $type = 'animated-alpha'; 5926 break; 5927 } 5928 5929 return compact( 'width', 'height', 'type' ); 5930 } 5931 5932 /** 5933 * Gets loading optimization attributes. 5934 * 5935 * This function returns an array of attributes that should be merged into the given attributes array to optimize 5936 * loading performance. Potential attributes returned by this function are: 5937 * - `loading` attribute with a value of "lazy" 5938 * - `fetchpriority` attribute with a value of "high" 5939 * - `decoding` attribute with a value of "async" 5940 * 5941 * If any of these attributes are already present in the given attributes, they will not be modified. Note that no 5942 * element should have both `loading="lazy"` and `fetchpriority="high"`, so the function will trigger a warning in case 5943 * both attributes are present with those values. 5944 * 5945 * @since 6.3.0 5946 * 5947 * @global WP_Query $wp_query WordPress Query object. 5948 * 5949 * @param string $tag_name The tag name. 5950 * @param array $attr Array of the attributes for the tag. 5951 * @param string $context Context for the element for which the loading optimization attribute is requested. 5952 * @return array Loading optimization attributes. 5953 */ 5954 function wp_get_loading_optimization_attributes( $tag_name, $attr, $context ) { 5955 global $wp_query; 5956 5957 /** 5958 * Filters whether to short-circuit loading optimization attributes. 5959 * 5960 * Returning an array from the filter will effectively short-circuit the loading of optimization attributes, 5961 * returning that value instead. 5962 * 5963 * @since 6.4.0 5964 * 5965 * @param array|false $loading_attrs False by default, or array of loading optimization attributes to short-circuit. 5966 * @param string $tag_name The tag name. 5967 * @param array $attr Array of the attributes for the tag. 5968 * @param string $context Context for the element for which the loading optimization attribute is requested. 5969 */ 5970 $loading_attrs = apply_filters( 'pre_wp_get_loading_optimization_attributes', false, $tag_name, $attr, $context ); 5971 5972 if ( is_array( $loading_attrs ) ) { 5973 return $loading_attrs; 5974 } 5975 5976 $loading_attrs = array(); 5977 5978 /* 5979 * Skip lazy-loading for the overall block template, as it is handled more granularly. 5980 * The skip is also applicable for `fetchpriority`. 5981 */ 5982 if ( 'template' === $context ) { 5983 /** This filter is documented in wp-includes/media.php */ 5984 return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context ); 5985 } 5986 5987 // For now this function only supports images and iframes. 5988 if ( 'img' !== $tag_name && 'iframe' !== $tag_name ) { 5989 /** This filter is documented in wp-includes/media.php */ 5990 return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context ); 5991 } 5992 5993 /* 5994 * Skip programmatically created images within content blobs as they need to be handled together with the other 5995 * images within the post content or widget content. 5996 * Without this clause, they would already be considered within their own context which skews the image count and 5997 * can result in the first post content image being lazy-loaded or an image further down the page being marked as a 5998 * high priority. 5999 */ 6000 if ( 6001 'the_content' !== $context && doing_filter( 'the_content' ) || 6002 'widget_text_content' !== $context && doing_filter( 'widget_text_content' ) || 6003 'widget_block_content' !== $context && doing_filter( 'widget_block_content' ) 6004 ) { 6005 /** This filter is documented in wp-includes/media.php */ 6006 return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context ); 6007 6008 } 6009 6010 /* 6011 * Add `decoding` with a value of "async" for every image unless it has a 6012 * conflicting `decoding` attribute already present. 6013 */ 6014 if ( 'img' === $tag_name ) { 6015 if ( isset( $attr['decoding'] ) ) { 6016 $loading_attrs['decoding'] = $attr['decoding']; 6017 } else { 6018 $loading_attrs['decoding'] = 'async'; 6019 } 6020 } 6021 6022 // For any resources, width and height must be provided, to avoid layout shifts. 6023 if ( ! isset( $attr['width'], $attr['height'] ) ) { 6024 /** This filter is documented in wp-includes/media.php */ 6025 return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context ); 6026 } 6027 6028 /* 6029 * The key function logic starts here. 6030 */ 6031 $maybe_in_viewport = null; 6032 $increase_count = false; 6033 $maybe_increase_count = false; 6034 6035 // Logic to handle a `loading` attribute that is already provided. 6036 if ( isset( $attr['loading'] ) ) { 6037 /* 6038 * Interpret "lazy" as not in viewport. Any other value can be 6039 * interpreted as in viewport (realistically only "eager" or `false` 6040 * to force-omit the attribute are other potential values). 6041 */ 6042 if ( 'lazy' === $attr['loading'] ) { 6043 $maybe_in_viewport = false; 6044 } else { 6045 $maybe_in_viewport = true; 6046 } 6047 } 6048 6049 // Logic to handle a `fetchpriority` attribute that is already provided. 6050 if ( isset( $attr['fetchpriority'] ) && 'high' === $attr['fetchpriority'] ) { 6051 /* 6052 * If the image was already determined to not be in the viewport (e.g. 6053 * from an already provided `loading` attribute), trigger a warning. 6054 * Otherwise, the value can be interpreted as in viewport, since only 6055 * the most important in-viewport image should have `fetchpriority` set 6056 * to "high". 6057 */ 6058 if ( false === $maybe_in_viewport ) { 6059 _doing_it_wrong( 6060 __FUNCTION__, 6061 __( 'An image should not be lazy-loaded and marked as high priority at the same time.' ), 6062 '6.3.0' 6063 ); 6064 /* 6065 * Set `fetchpriority` here for backward-compatibility as we should 6066 * not override what a developer decided, even though it seems 6067 * incorrect. 6068 */ 6069 $loading_attrs['fetchpriority'] = 'high'; 6070 } else { 6071 $maybe_in_viewport = true; 6072 } 6073 } 6074 6075 if ( null === $maybe_in_viewport ) { 6076 $header_enforced_contexts = array( 6077 'template_part_' . WP_TEMPLATE_PART_AREA_HEADER => true, 6078 'get_header_image_tag' => true, 6079 ); 6080 6081 /** 6082 * Filters the header-specific contexts. 6083 * 6084 * @since 6.4.0 6085 * 6086 * @param array $default_header_enforced_contexts Map of contexts for which elements should be considered 6087 * in the header of the page, as $context => $enabled 6088 * pairs. The $enabled should always be true. 6089 */ 6090 $header_enforced_contexts = apply_filters( 'wp_loading_optimization_force_header_contexts', $header_enforced_contexts ); 6091 6092 // Consider elements with these header-specific contexts to be in viewport. 6093 if ( isset( $header_enforced_contexts[ $context ] ) ) { 6094 $maybe_in_viewport = true; 6095 $maybe_increase_count = true; 6096 } elseif ( ! is_admin() && in_the_loop() && is_main_query() ) { 6097 /* 6098 * Get the content media count, since this is a main query 6099 * content element. This is accomplished by "increasing" 6100 * the count by zero, as the only way to get the count is 6101 * to call this function. 6102 * The actual count increase happens further below, based 6103 * on the `$increase_count` flag set here. 6104 */ 6105 $content_media_count = wp_increase_content_media_count( 0 ); 6106 $increase_count = true; 6107 6108 // If the count so far is below the threshold, `loading` attribute is omitted. 6109 if ( $content_media_count < wp_omit_loading_attr_threshold() ) { 6110 $maybe_in_viewport = true; 6111 } else { 6112 $maybe_in_viewport = false; 6113 } 6114 } elseif ( 6115 // Only apply for main query but before the loop. 6116 $wp_query->before_loop && $wp_query->is_main_query() 6117 /* 6118 * Any image before the loop, but after the header has started should not be lazy-loaded, 6119 * except when the footer has already started which can happen when the current template 6120 * does not include any loop. 6121 */ 6122 && did_action( 'get_header' ) && ! did_action( 'get_footer' ) 6123 ) { 6124 $maybe_in_viewport = true; 6125 $maybe_increase_count = true; 6126 } 6127 } 6128 6129 /* 6130 * If the element is in the viewport (`true`), potentially add 6131 * `fetchpriority` with a value of "high". Otherwise, i.e. if the element 6132 * is not not in the viewport (`false`) or it is unknown (`null`), add 6133 * `loading` with a value of "lazy". 6134 */ 6135 if ( $maybe_in_viewport ) { 6136 $loading_attrs = wp_maybe_add_fetchpriority_high_attr( $loading_attrs, $tag_name, $attr ); 6137 } else { 6138 // Only add `loading="lazy"` if the feature is enabled. 6139 if ( wp_lazy_loading_enabled( $tag_name, $context ) ) { 6140 $loading_attrs['loading'] = 'lazy'; 6141 } 6142 } 6143 6144 /* 6145 * If flag was set based on contextual logic above, increase the content 6146 * media count, either unconditionally, or based on whether the image size 6147 * is larger than the threshold. 6148 */ 6149 if ( $increase_count ) { 6150 wp_increase_content_media_count(); 6151 } elseif ( $maybe_increase_count ) { 6152 /** This filter is documented in wp-includes/media.php */ 6153 $wp_min_priority_img_pixels = apply_filters( 'wp_min_priority_img_pixels', 50000 ); 6154 6155 if ( $wp_min_priority_img_pixels <= $attr['width'] * $attr['height'] ) { 6156 wp_increase_content_media_count(); 6157 } 6158 } 6159 6160 /** 6161 * Filters the loading optimization attributes. 6162 * 6163 * @since 6.4.0 6164 * 6165 * @param array $loading_attrs The loading optimization attributes. 6166 * @param string $tag_name The tag name. 6167 * @param array $attr Array of the attributes for the tag. 6168 * @param string $context Context for the element for which the loading optimization attribute is requested. 6169 */ 6170 return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context ); 6171 } 6172 6173 /** 6174 * Gets the threshold for how many of the first content media elements to not lazy-load. 6175 * 6176 * This function runs the {@see 'wp_omit_loading_attr_threshold'} filter, which uses a default threshold value of 3. 6177 * The filter is only run once per page load, unless the `$force` parameter is used. 6178 * 6179 * @since 5.9.0 6180 * 6181 * @param bool $force Optional. If set to true, the filter will be (re-)applied even if it already has been before. 6182 * Default false. 6183 * @return int The number of content media elements to not lazy-load. 6184 */ 6185 function wp_omit_loading_attr_threshold( $force = false ) { 6186 static $omit_threshold; 6187 6188 // This function may be called multiple times. Run the filter only once per page load. 6189 if ( ! isset( $omit_threshold ) || $force ) { 6190 /** 6191 * Filters the threshold for how many of the first content media elements to not lazy-load. 6192 * 6193 * For these first content media elements, the `loading` attribute will be omitted. By default, this is the case 6194 * for only the very first content media element. 6195 * 6196 * @since 5.9.0 6197 * @since 6.3.0 The default threshold was changed from 1 to 3. 6198 * 6199 * @param int $omit_threshold The number of media elements where the `loading` attribute will not be added. Default 3. 6200 */ 6201 $omit_threshold = apply_filters( 'wp_omit_loading_attr_threshold', 3 ); 6202 } 6203 6204 return $omit_threshold; 6205 } 6206 6207 /** 6208 * Increases an internal content media count variable. 6209 * 6210 * @since 5.9.0 6211 * @access private 6212 * 6213 * @param int $amount Optional. Amount to increase by. Default 1. 6214 * @return int The latest content media count, after the increase. 6215 */ 6216 function wp_increase_content_media_count( $amount = 1 ) { 6217 static $content_media_count = 0; 6218 6219 $content_media_count += $amount; 6220 6221 return $content_media_count; 6222 } 6223 6224 /** 6225 * Determines whether to add `fetchpriority='high'` to loading attributes. 6226 * 6227 * @since 6.3.0 6228 * @access private 6229 * 6230 * @param array $loading_attrs Array of the loading optimization attributes for the element. 6231 * @param string $tag_name The tag name. 6232 * @param array $attr Array of the attributes for the element. 6233 * @return array Updated loading optimization attributes for the element. 6234 */ 6235 function wp_maybe_add_fetchpriority_high_attr( $loading_attrs, $tag_name, $attr ) { 6236 // For now, adding `fetchpriority="high"` is only supported for images. 6237 if ( 'img' !== $tag_name ) { 6238 return $loading_attrs; 6239 } 6240 6241 if ( isset( $attr['fetchpriority'] ) ) { 6242 /* 6243 * While any `fetchpriority` value could be set in `$loading_attrs`, 6244 * for consistency we only do it for `fetchpriority="high"` since that 6245 * is the only possible value that WordPress core would apply on its 6246 * own. 6247 */ 6248 if ( 'high' === $attr['fetchpriority'] ) { 6249 $loading_attrs['fetchpriority'] = 'high'; 6250 wp_high_priority_element_flag( false ); 6251 } 6252 6253 return $loading_attrs; 6254 } 6255 6256 // Lazy-loading and `fetchpriority="high"` are mutually exclusive. 6257 if ( isset( $loading_attrs['loading'] ) && 'lazy' === $loading_attrs['loading'] ) { 6258 return $loading_attrs; 6259 } 6260 6261 if ( ! wp_high_priority_element_flag() ) { 6262 return $loading_attrs; 6263 } 6264 6265 /** 6266 * Filters the minimum square-pixels threshold for an image to be eligible as the high-priority image. 6267 * 6268 * @since 6.3.0 6269 * 6270 * @param int $threshold Minimum square-pixels threshold. Default 50000. 6271 */ 6272 $wp_min_priority_img_pixels = apply_filters( 'wp_min_priority_img_pixels', 50000 ); 6273 6274 if ( $wp_min_priority_img_pixels <= $attr['width'] * $attr['height'] ) { 6275 $loading_attrs['fetchpriority'] = 'high'; 6276 wp_high_priority_element_flag( false ); 6277 } 6278 6279 return $loading_attrs; 6280 } 6281 6282 /** 6283 * Accesses a flag that indicates if an element is a possible candidate for `fetchpriority='high'`. 6284 * 6285 * @since 6.3.0 6286 * @access private 6287 * 6288 * @param bool $value Optional. Used to change the static variable. Default null. 6289 * @return bool Returns true if high-priority element was marked already, otherwise false. 6290 */ 6291 function wp_high_priority_element_flag( $value = null ) { 6292 static $high_priority_element = true; 6293 6294 if ( is_bool( $value ) ) { 6295 $high_priority_element = $value; 6296 } 6297 6298 return $high_priority_element; 6299 } 6300 6301 /** 6302 * Determines the output format for the image editor. 6303 * 6304 * @since 6.7.0 6305 * @access private 6306 * 6307 * @param string $filename Path to the image. 6308 * @param string $mime_type The source image mime type. 6309 * @return string[] An array of mime type mappings. 6310 */ 6311 function wp_get_image_editor_output_format( $filename, $mime_type ) { 6312 $output_format = array( 6313 'image/heic' => 'image/jpeg', 6314 'image/heif' => 'image/jpeg', 6315 'image/heic-sequence' => 'image/jpeg', 6316 'image/heif-sequence' => 'image/jpeg', 6317 ); 6318 6319 /** 6320 * Filters the image editor output format mapping. 6321 * 6322 * Enables filtering the mime type used to save images. By default HEIC/HEIF images 6323 * are converted to JPEGs. 6324 * 6325 * @see WP_Image_Editor::get_output_format() 6326 * 6327 * @since 5.8.0 6328 * @since 6.7.0 The default was changed from an empty array to an array 6329 * containing the HEIC/HEIF images mime types. 6330 * 6331 * @param string[] $output_format { 6332 * An array of mime type mappings. Maps a source mime type to a new 6333 * destination mime type. By default maps HEIC/HEIF input to JPEG output. 6334 * 6335 * @type string ...$0 The new mime type. 6336 * } 6337 * @param string $filename Path to the image. 6338 * @param string $mime_type The source image mime type. 6339 */ 6340 return apply_filters( 'image_editor_output_format', $output_format, $filename, $mime_type ); 6341 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Fri Jul 25 08:20:01 2025 | Cross-referenced by PHPXref |