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