ru-se.com

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs

media.php (178105B)


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