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