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