X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/00dbffaf1593b0ac719d98f00839221a9ca52133..refs/tags/wordpress-4.5:/wp-includes/media.php?ds=sidebyside diff --git a/wp-includes/media.php b/wp-includes/media.php index d664e073..9f35f798 100644 --- a/wp-includes/media.php +++ b/wp-includes/media.php @@ -11,29 +11,34 @@ * * This is so that the image is a better fit for the editor and theme. * - * The $size parameter accepts either an array or a string. The supported string + * The `$size` parameter accepts either an array or a string. The supported string * values are 'thumb' or 'thumbnail' for the given thumbnail size or defaults at * 128 width and 96 height in pixels. Also supported for the string value is - * 'medium' and 'full'. The 'full' isn't actually supported, but any value other + * 'medium', 'medium_large' and 'full'. The 'full' isn't actually supported, but any value other * than the supported will result in the content_width size or 500 if that is * not set. * - * Finally, there is a filter named 'editor_max_image_size', that will be called - * on the calculated array for width and height, respectively. The second + * Finally, there is a filter named {@see 'editor_max_image_size'}, that will be + * called on the calculated array for width and height, respectively. The second * parameter will be the value that was in the $size parameter. The returned * type for the hook is an array with the width as the first element and the * height as the second element. * * @since 2.5.0 - * @uses wp_constrain_dimensions() This function passes the widths and the heights. * - * @param int $width Width of the image - * @param int $height Height of the image - * @param string|array $size Size of what the result image should be. - * @param context Could be 'display' (like in a theme) or 'edit' (like inserting into an editor) + * @global int $content_width + * @global array $_wp_additional_image_sizes + * + * @param int $width Width of the image in pixels. + * @param int $height Height of the image in pixels. + * @param string|array $size Optional. Image size. Accepts any valid image size, or an array + * of width and height values in pixels (in that order). + * Default 'medium'. + * @param string $context Optional. Could be 'display' (like in a theme) or 'edit' + * (like inserting into an editor). Default null. * @return array Width and height of what the result image should resize to. */ -function image_constrain_size_for_editor($width, $height, $size = 'medium', $context = null ) { +function image_constrain_size_for_editor( $width, $height, $size = 'medium', $context = null ) { global $content_width, $_wp_additional_image_sizes; if ( ! $context ) @@ -55,17 +60,28 @@ function image_constrain_size_for_editor($width, $height, $size = 'medium', $con elseif ( $size == 'medium' ) { $max_width = intval(get_option('medium_size_w')); $max_height = intval(get_option('medium_size_h')); - // if no width is set, default to the theme content width if available + + } + elseif ( $size == 'medium_large' ) { + $max_width = intval( get_option( 'medium_large_size_w' ) ); + $max_height = intval( get_option( 'medium_large_size_h' ) ); + + if ( intval( $content_width ) > 0 ) { + $max_width = min( intval( $content_width ), $max_width ); + } } elseif ( $size == 'large' ) { - // We're inserting a large size image into the editor. If it's a really - // big image we'll scale it down to fit reasonably within the editor - // itself, and within the theme's content width if it's known. The user - // can resize it in the editor if they wish. + /* + * We're inserting a large size image into the editor. If it's a really + * big image we'll scale it down to fit reasonably within the editor + * itself, and within the theme's content width if it's known. The user + * can resize it in the editor if they wish. + */ $max_width = intval(get_option('large_size_w')); $max_height = intval(get_option('large_size_h')); - if ( intval($content_width) > 0 ) + if ( intval($content_width) > 0 ) { $max_width = min( intval($content_width), $max_width ); + } } elseif ( isset( $_wp_additional_image_sizes ) && count( $_wp_additional_image_sizes ) && in_array( $size, array_keys( $_wp_additional_image_sizes ) ) ) { $max_width = intval( $_wp_additional_image_sizes[$size]['width'] ); $max_height = intval( $_wp_additional_image_sizes[$size]['height'] ); @@ -78,6 +94,18 @@ function image_constrain_size_for_editor($width, $height, $size = 'medium', $con $max_height = $height; } + /** + * Filter the maximum image size dimensions for the editor. + * + * @since 2.5.0 + * + * @param array $max_image_size An array with the width as the first element, + * and the height as the second element. + * @param string|array $size Size of what the result image should be. + * @param string $context The context the image is being resized for. + * Possible values are 'display' (like in a theme) + * or 'edit' (like inserting into an editor). + */ list( $max_width, $max_height ) = apply_filters( 'editor_max_image_size', array( $max_width, $max_height ), $size, $context ); return wp_constrain_dimensions( $width, $height, $max_width, $max_height ); @@ -96,11 +124,11 @@ function image_constrain_size_for_editor($width, $height, $size = 'medium', $con * * @since 2.5.0 * - * @param int|string $width Optional. Width attribute value. - * @param int|string $height Optional. Height attribute value. + * @param int|string $width Image width in pixels. + * @param int|string $height Image height in pixels. * @return string HTML attributes for width and, or height. */ -function image_hwstring($width, $height) { +function image_hwstring( $width, $height ) { $out = ''; if ($width) $out .= 'width="'.intval($width).'" '; @@ -126,28 +154,42 @@ function image_hwstring($width, $height) { * to the new image that was resized. * * @since 2.5.0 - * @uses apply_filters() Calls 'image_downsize' on $id and $size to provide - * resize services. * - * @param int $id Attachment ID for image. - * @param array|string $size Optional, default is 'medium'. Size of image, either array or string. - * @return bool|array False on failure, array on success. + * @param int $id Attachment ID for image. + * @param array|string $size Optional. Image size to scale to. Accepts any valid image size, + * or an array of width and height values in pixels (in that order). + * Default 'medium'. + * @return false|array Array containing the image URL, width, height, and boolean for whether + * the image is an intermediate size. False on failure. */ -function image_downsize($id, $size = 'medium') { +function image_downsize( $id, $size = 'medium' ) { if ( !wp_attachment_is_image($id) ) return false; + /** + * Filter whether to preempt the output of image_downsize(). + * + * Passing a truthy value to the filter will effectively short-circuit + * down-sizing the image, returning that value as output instead. + * + * @since 2.5.0 + * + * @param bool $downsize Whether to short-circuit the image downsize. Default false. + * @param int $id Attachment ID for image. + * @param array|string $size Size of image. Image size or array of width and height values (in that order). + * Default 'medium'. + */ + if ( $out = apply_filters( 'image_downsize', false, $id, $size ) ) { + return $out; + } + $img_url = wp_get_attachment_url($id); $meta = wp_get_attachment_metadata($id); $width = $height = 0; $is_intermediate = false; $img_url_basename = wp_basename($img_url); - // plugins can use this to provide resize services - if ( $out = apply_filters('image_downsize', false, $id, $size) ) - return $out; - // try for a new style intermediate size if ( $intermediate = image_get_intermediate_size($id, $size) ) { $img_url = str_replace($img_url_basename, $intermediate['file'], $img_url); @@ -164,7 +206,7 @@ function image_downsize($id, $size = 'medium') { $is_intermediate = true; } } - if ( !$width && !$height && isset($meta['width'], $meta['height']) ) { + if ( !$width && !$height && isset( $meta['width'], $meta['height'] ) ) { // any other type: use the real image $width = $meta['width']; $height = $meta['height']; @@ -181,26 +223,91 @@ function image_downsize($id, $size = 'medium') { } /** - * Registers a new image size + * Register a new image size. + * + * Cropping behavior for the image size is dependent on the value of $crop: + * 1. If false (default), images will be scaled, not cropped. + * 2. If an array in the form of array( x_crop_position, y_crop_position ): + * - x_crop_position accepts 'left' 'center', or 'right'. + * - y_crop_position accepts 'top', 'center', or 'bottom'. + * Images will be cropped to the specified dimensions within the defined crop area. + * 3. If true, images will be cropped to the specified dimensions using center positions. * * @since 2.9.0 + * + * @global array $_wp_additional_image_sizes Associative array of additional image sizes. + * + * @param string $name Image size identifier. + * @param int $width Image width in pixels. + * @param int $height Image height in pixels. + * @param bool|array $crop Optional. Whether to crop images to specified width and height or resize. + * An array can specify positioning of the crop area. Default false. */ function add_image_size( $name, $width = 0, $height = 0, $crop = false ) { global $_wp_additional_image_sizes; - $_wp_additional_image_sizes[$name] = array( 'width' => absint( $width ), 'height' => absint( $height ), 'crop' => (bool) $crop ); + + $_wp_additional_image_sizes[ $name ] = array( + 'width' => absint( $width ), + 'height' => absint( $height ), + 'crop' => $crop, + ); +} + +/** + * Check if an image size exists. + * + * @since 3.9.0 + * + * @global array $_wp_additional_image_sizes + * + * @param string $name The image size to check. + * @return bool True if the image size exists, false if not. + */ +function has_image_size( $name ) { + global $_wp_additional_image_sizes; + + return isset( $_wp_additional_image_sizes[ $name ] ); +} + +/** + * Remove a new image size. + * + * @since 3.9.0 + * + * @global array $_wp_additional_image_sizes + * + * @param string $name The image size to remove. + * @return bool True if the image size was successfully removed, false on failure. + */ +function remove_image_size( $name ) { + global $_wp_additional_image_sizes; + + if ( isset( $_wp_additional_image_sizes[ $name ] ) ) { + unset( $_wp_additional_image_sizes[ $name ] ); + return true; + } + + return false; } /** - * Registers an image size for the post thumbnail + * Registers an image size for the post thumbnail. * * @since 2.9.0 + * + * @see add_image_size() for details on cropping behavior. + * + * @param int $width Image width in pixels. + * @param int $height Image height in pixels. + * @param bool|array $crop Optional. Whether to crop images to specified width and height or resize. + * An array can specify positioning of the crop area. Default false. */ function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) { add_image_size( 'post-thumbnail', $width, $height, $crop ); } /** - * An tag for an image attachment, scaling it down if requested. + * Gets an img tag for an image attachment, scaling it down if requested. * * The filter 'get_image_tag_class' allows for changing the class name for the * image without having to use regular expressions on the HTML content. The @@ -213,19 +320,16 @@ function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) { * * @since 2.5.0 * - * @uses apply_filters() The 'get_image_tag_class' filter is the IMG element - * class attribute. - * @uses apply_filters() The 'get_image_tag' filter is the full IMG element with - * all attributes. - * - * @param int $id Attachment ID. - * @param string $alt Image Description for the alt attribute. - * @param string $title Image Description for the title attribute. - * @param string $align Part of the class name for aligning the image. - * @param string $size Optional. Default is 'medium'. + * @param int $id Attachment ID. + * @param string $alt Image Description for the alt attribute. + * @param string $title Image Description for the title attribute. + * @param string $align Part of the class name for aligning the image. + * @param string|array $size Optional. Registered image size to retrieve a tag for. Accepts any + * valid image size, or an array of width and height values in pixels + * (in that order). Default 'medium'. * @return string HTML IMG element for given image attachment */ -function get_image_tag($id, $alt, $title, $align, $size='medium') { +function get_image_tag( $id, $alt, $title, $align, $size = 'medium' ) { list( $img_src, $width, $height ) = image_downsize($id, $size); $hwstring = image_hwstring($width, $height); @@ -233,31 +337,54 @@ function get_image_tag($id, $alt, $title, $align, $size='medium') { $title = $title ? 'title="' . esc_attr( $title ) . '" ' : ''; $class = 'align' . esc_attr($align) .' size-' . esc_attr($size) . ' wp-image-' . $id; - $class = apply_filters('get_image_tag_class', $class, $id, $align, $size); - $html = '' . esc_attr($alt) . ''; + /** + * Filter the value of the attachment's image tag class attribute. + * + * @since 2.6.0 + * + * @param string $class CSS class name or space-separated list of classes. + * @param int $id Attachment ID. + * @param string $align Part of the class name for aligning the image. + * @param string|array $size Size of image. Image size or array of width and height values (in that order). + * Default 'medium'. + */ + $class = apply_filters( 'get_image_tag_class', $class, $id, $align, $size ); - $html = apply_filters( 'get_image_tag', $html, $id, $alt, $title, $align, $size ); + $html = '' . esc_attr($alt) . ''; - return $html; + /** + * Filter the HTML content for the image tag. + * + * @since 2.6.0 + * + * @param string $html HTML content for the image. + * @param int $id Attachment ID. + * @param string $alt Alternate text. + * @param string $title Attachment title. + * @param string $align Part of the class name for aligning the image. + * @param string|array $size Size of image. Image size or array of width and height values (in that order). + * Default 'medium'. + */ + return apply_filters( 'get_image_tag', $html, $id, $alt, $title, $align, $size ); } /** - * Calculates the new dimensions for a downsampled image. + * Calculates the new dimensions for a down-sampled image. * * If either width or height are empty, no constraint is applied on * that dimension. * * @since 2.5.0 * - * @param int $current_width Current width of the image. + * @param int $current_width Current width of the image. * @param int $current_height Current height of the image. - * @param int $max_width Optional. Maximum wanted width. - * @param int $max_height Optional. Maximum wanted height. + * @param int $max_width Optional. Max width in pixels to constrain to. Default 0. + * @param int $max_height Optional. Max height in pixels to constrain to. Default 0. * @return array First item is the width, the second item is the height. */ -function wp_constrain_dimensions( $current_width, $current_height, $max_width=0, $max_height=0 ) { - if ( !$max_width and !$max_height ) +function wp_constrain_dimensions( $current_width, $current_height, $max_width = 0, $max_height = 0 ) { + if ( !$max_width && !$max_height ) return array( $current_width, $current_height ); $width_ratio = $height_ratio = 1.0; @@ -277,46 +404,71 @@ function wp_constrain_dimensions( $current_width, $current_height, $max_width=0, $smaller_ratio = min( $width_ratio, $height_ratio ); $larger_ratio = max( $width_ratio, $height_ratio ); - if ( intval( $current_width * $larger_ratio ) > $max_width || intval( $current_height * $larger_ratio ) > $max_height ) + if ( (int) round( $current_width * $larger_ratio ) > $max_width || (int) round( $current_height * $larger_ratio ) > $max_height ) { // The larger ratio is too big. It would result in an overflow. $ratio = $smaller_ratio; - else + } else { // The larger ratio fits, and is likely to be a more "snug" fit. $ratio = $larger_ratio; + } - $w = intval( $current_width * $ratio ); - $h = intval( $current_height * $ratio ); + // Very small dimensions may result in 0, 1 should be the minimum. + $w = max ( 1, (int) round( $current_width * $ratio ) ); + $h = max ( 1, (int) round( $current_height * $ratio ) ); // Sometimes, due to rounding, we'll end up with a result like this: 465x700 in a 177x177 box is 117x176... a pixel short // We also have issues with recursive calls resulting in an ever-changing result. Constraining to the result of a constraint should yield the original result. // Thus we look for dimensions that are one pixel shy of the max value and bump them up - if ( $did_width && $w == $max_width - 1 ) + + // Note: $did_width means it is possible $smaller_ratio == $width_ratio. + if ( $did_width && $w == $max_width - 1 ) { $w = $max_width; // Round it up - if ( $did_height && $h == $max_height - 1 ) + } + + // Note: $did_height means it is possible $smaller_ratio == $height_ratio. + if ( $did_height && $h == $max_height - 1 ) { $h = $max_height; // Round it up + } - return array( $w, $h ); + /** + * Filter dimensions to constrain down-sampled images to. + * + * @since 4.1.0 + * + * @param array $dimensions The image width and height. + * @param int $current_width The current width of the image. + * @param int $current_height The current height of the image. + * @param int $max_width The maximum width permitted. + * @param int $max_height The maximum height permitted. + */ + return apply_filters( 'wp_constrain_dimensions', array( $w, $h ), $current_width, $current_height, $max_width, $max_height ); } /** - * Retrieve calculated resized dimensions for use in WP_Image_Editor. + * Retrieves calculated resize dimensions for use in WP_Image_Editor. * - * Calculate dimensions and coordinates for a resized image that fits within a - * specified width and height. If $crop is true, the largest matching central - * portion of the image will be cropped out and resized to the required size. + * Calculates dimensions and coordinates for a resized image that fits + * within a specified width and height. + * + * Cropping behavior is dependent on the value of $crop: + * 1. If false (default), images will not be cropped. + * 2. If an array in the form of array( x_crop_position, y_crop_position ): + * - x_crop_position accepts 'left' 'center', or 'right'. + * - y_crop_position accepts 'top', 'center', or 'bottom'. + * Images will be cropped to the specified dimensions within the defined crop area. + * 3. If true, images will be cropped to the specified dimensions using center positions. * * @since 2.5.0 - * @uses apply_filters() Calls 'image_resize_dimensions' on $orig_w, $orig_h, $dest_w, $dest_h and - * $crop to provide custom resize dimensions. - * - * @param int $orig_w Original width. - * @param int $orig_h Original height. - * @param int $dest_w New width. - * @param int $dest_h New height. - * @param bool $crop Optional, default is false. Whether to crop image or resize. - * @return bool|array False on failure. Returned array matches parameters for imagecopyresampled() PHP function. + * + * @param int $orig_w Original width in pixels. + * @param int $orig_h Original height in pixels. + * @param int $dest_w New width in pixels. + * @param int $dest_h New height in pixels. + * @param bool|array $crop Optional. Whether to crop image to specified width and height or resize. + * An array can specify positioning of the crop area. Default false. + * @return false|array False on failure. Returned array matches parameters for `imagecopyresampled()`. */ -function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = false) { +function image_resize_dimensions( $orig_w, $orig_h, $dest_w, $dest_h, $crop = false ) { if ($orig_w <= 0 || $orig_h <= 0) return false; @@ -324,7 +476,22 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = fal if ($dest_w <= 0 && $dest_h <= 0) return false; - // plugins can use this to provide custom resize dimensions + /** + * Filter whether to preempt calculating the image resize dimensions. + * + * Passing a non-null value to the filter will effectively short-circuit + * image_resize_dimensions(), returning that value instead. + * + * @since 3.4.0 + * + * @param null|mixed $null Whether to preempt output of the resize dimensions. + * @param int $orig_w Original width in pixels. + * @param int $orig_h Original height in pixels. + * @param int $dest_w New width in pixels. + * @param int $dest_h New height in pixels. + * @param bool|array $crop Whether to crop image to specified width and height or resize. + * An array can specify positioning of the crop area. Default false. + */ $output = apply_filters( 'image_resize_dimensions', null, $orig_w, $orig_h, $dest_w, $dest_h, $crop ); if ( null !== $output ) return $output; @@ -335,12 +502,12 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = fal $new_w = min($dest_w, $orig_w); $new_h = min($dest_h, $orig_h); - if ( !$new_w ) { - $new_w = intval($new_h * $aspect_ratio); + if ( ! $new_w ) { + $new_w = (int) round( $new_h * $aspect_ratio ); } - if ( !$new_h ) { - $new_h = intval($new_w / $aspect_ratio); + if ( ! $new_h ) { + $new_h = (int) round( $new_w / $aspect_ratio ); } $size_ratio = max($new_w / $orig_w, $new_h / $orig_h); @@ -348,8 +515,27 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = fal $crop_w = round($new_w / $size_ratio); $crop_h = round($new_h / $size_ratio); - $s_x = floor( ($orig_w - $crop_w) / 2 ); - $s_y = floor( ($orig_h - $crop_h) / 2 ); + if ( ! is_array( $crop ) || count( $crop ) !== 2 ) { + $crop = array( 'center', 'center' ); + } + + list( $x, $y ) = $crop; + + if ( 'left' === $x ) { + $s_x = 0; + } elseif ( 'right' === $x ) { + $s_x = $orig_w - $crop_w; + } else { + $s_x = floor( ( $orig_w - $crop_w ) / 2 ); + } + + if ( 'top' === $y ) { + $s_y = 0; + } elseif ( 'bottom' === $y ) { + $s_y = $orig_h - $crop_h; + } else { + $s_y = floor( ( $orig_h - $crop_h ) / 2 ); + } } else { // don't crop, just resize using $dest_w x $dest_h as a maximum bounding box $crop_w = $orig_w; @@ -362,8 +548,9 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = fal } // if the resulting image would be the same size or larger we don't want to resize it - if ( $new_w >= $orig_w && $new_h >= $orig_h ) + if ( $new_w >= $orig_w && $new_h >= $orig_h && $dest_w != $orig_w && $dest_h != $orig_h ) { return false; + } // the return array matches the parameters to imagecopyresampled() // int dst_x, int dst_y, int src_x, int src_y, int dst_w, int dst_h, int src_w, int src_h @@ -372,7 +559,7 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = fal } /** - * Resize an image to make a thumbnail or intermediate size. + * Resizes an image to make a thumbnail or intermediate size. * * The returned array has the file size, the image width, and image height. The * filter 'image_make_intermediate_size' can be used to hook in and change the @@ -380,11 +567,12 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = fal * * @since 2.5.0 * - * @param string $file File path. - * @param int $width Image width. - * @param int $height Image height. - * @param bool $crop Optional, default is false. Whether to crop image to specified height and width or resize. - * @return bool|array False, if no image was created. Metadata array on success. + * @param string $file File path. + * @param int $width Image width. + * @param int $height Image height. + * @param bool $crop Optional. Whether to crop image to specified width and height or resize. + * Default false. + * @return false|array False, if no image was created. Metadata array on success. */ function image_make_intermediate_size( $file, $width, $height, $crop = false ) { if ( $width || $height ) { @@ -404,7 +592,7 @@ function image_make_intermediate_size( $file, $width, $height, $crop = false ) { } /** - * Retrieve the image's intermediate size (resized) path, width, and height. + * Retrieves the image's intermediate size (resized) path, width, and height. * * The $size parameter can be an array with the width and height respectively. * If the size matches the 'sizes' metadata array for width and height, then it @@ -423,45 +611,68 @@ function image_make_intermediate_size( $file, $width, $height, $crop = false ) { * browser scale down the image. * * @since 2.5.0 - * @see add_image_size() * - * @param int $post_id Attachment ID for image. - * @param array|string $size Optional, default is 'thumbnail'. Size of image, either array or string. - * @return bool|array False on failure or array of file path, width, and height on success. + * @param int $post_id Attachment ID. + * @param array|string $size Optional. Image size. Accepts any valid image size, or an array + * of width and height values in pixels (in that order). + * Default 'thumbnail'. + * @return false|array $data { + * Array of file relative path, width, and height on success. Additionally includes absolute + * path and URL if registered size is passed to $size parameter. False on failure. + * + * @type string $file Image's path relative to uploads directory + * @type int $width Width of image + * @type int $height Height of image + * @type string $path Optional. Image's absolute filesystem path. Only returned if registered + * size is passed to `$size` parameter. + * @type string $url Optional. Image's URL. Only returned if registered size is passed to `$size` + * parameter. + * } */ -function image_get_intermediate_size($post_id, $size='thumbnail') { +function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) { if ( !is_array( $imagedata = wp_get_attachment_metadata( $post_id ) ) ) return false; // get the best one for a specified set of dimensions if ( is_array($size) && !empty($imagedata['sizes']) ) { + $candidates = array(); + foreach ( $imagedata['sizes'] as $_size => $data ) { - // already cropped to width or height; so use this size - if ( ( $data['width'] == $size[0] && $data['height'] <= $size[1] ) || ( $data['height'] == $size[1] && $data['width'] <= $size[0] ) ) { - $file = $data['file']; - list($width, $height) = image_constrain_size_for_editor( $data['width'], $data['height'], $size ); - return compact( 'file', 'width', 'height' ); + // If there's an exact match to an existing image size, short circuit. + if ( $data['width'] == $size[0] && $data['height'] == $size[1] ) { + list( $data['width'], $data['height'] ) = image_constrain_size_for_editor( $data['width'], $data['height'], $size ); + + /** This filter is documented in wp-includes/media.php */ + return apply_filters( 'image_get_intermediate_size', $data, $post_id, $size ); + } + // If it's not an exact match but it's at least the dimensions requested. + if ( $data['width'] >= $size[0] && $data['height'] >= $size[1] ) { + $candidates[ $data['width'] * $data['height'] ] = $_size; } - // add to lookup table: area => size - $areas[$data['width'] * $data['height']] = $_size; } - if ( !$size || !empty($areas) ) { + + if ( ! empty( $candidates ) ) { // find for the smallest image not smaller than the desired size - ksort($areas); - foreach ( $areas as $_size ) { + ksort( $candidates ); + foreach ( $candidates as $_size ) { $data = $imagedata['sizes'][$_size]; - if ( $data['width'] >= $size[0] || $data['height'] >= $size[1] ) { - // Skip images with unexpectedly divergent aspect ratios (crops) - // First, we calculate what size the original image would be if constrained to a box the size of the current image in the loop - $maybe_cropped = image_resize_dimensions($imagedata['width'], $imagedata['height'], $data['width'], $data['height'], false ); - // If the size doesn't match within one pixel, then it is of a different aspect ratio, so we skip it, unless it's the thumbnail size - if ( 'thumbnail' != $_size && ( !$maybe_cropped || ( $maybe_cropped[4] != $data['width'] && $maybe_cropped[4] + 1 != $data['width'] ) || ( $maybe_cropped[5] != $data['height'] && $maybe_cropped[5] + 1 != $data['height'] ) ) ) - continue; - // If we're still here, then we're going to use this size - $file = $data['file']; - list($width, $height) = image_constrain_size_for_editor( $data['width'], $data['height'], $size ); - return compact( 'file', 'width', 'height' ); + + // Skip images with unexpectedly divergent aspect ratios (crops) + // First, we calculate what size the original image would be if constrained to a box the size of the current image in the loop + $maybe_cropped = image_resize_dimensions($imagedata['width'], $imagedata['height'], $data['width'], $data['height'], false ); + // If the size doesn't match within one pixel, then it is of a different aspect ratio, so we skip it, unless it's the thumbnail size + if ( 'thumbnail' != $_size && + ( ! $maybe_cropped + || ( $maybe_cropped[4] != $data['width'] && $maybe_cropped[4] + 1 != $data['width'] ) + || ( $maybe_cropped[5] != $data['height'] && $maybe_cropped[5] + 1 != $data['height'] ) + ) ) { + continue; } + // If we're still here, then we're going to use this size. + list( $data['width'], $data['height'] ) = image_constrain_size_for_editor( $data['width'], $data['height'], $size ); + + /** This filter is documented in wp-includes/media.php */ + return apply_filters( 'image_get_intermediate_size', $data, $post_id, $size ); } } } @@ -476,20 +687,46 @@ function image_get_intermediate_size($post_id, $size='thumbnail') { $data['path'] = path_join( dirname($imagedata['file']), $data['file'] ); $data['url'] = path_join( dirname($file_url), $data['file'] ); } - return $data; + + /** + * Filter the output of image_get_intermediate_size() + * + * @since 4.4.0 + * + * @see image_get_intermediate_size() + * + * @param array $data Array of file relative path, width, and height on success. May also include + * file absolute path and URL. + * @param int $post_id The post_id of the image attachment + * @param string|array $size Registered image size or flat array of initially-requested height and width + * dimensions (in that order). + */ + return apply_filters( 'image_get_intermediate_size', $data, $post_id, $size ); } /** - * Get the available image sizes + * Gets the available intermediate image sizes. + * * @since 3.0.0 - * @return array Returns a filtered array of image size strings + * + * @global array $_wp_additional_image_sizes + * + * @return array Returns a filtered array of image size strings. */ function get_intermediate_image_sizes() { global $_wp_additional_image_sizes; - $image_sizes = array('thumbnail', 'medium', 'large'); // Standard sizes + $image_sizes = array('thumbnail', 'medium', 'medium_large', 'large'); // Standard sizes if ( isset( $_wp_additional_image_sizes ) && count( $_wp_additional_image_sizes ) ) $image_sizes = array_merge( $image_sizes, array_keys( $_wp_additional_image_sizes ) ); + /** + * Filter the list of intermediate image sizes. + * + * @since 2.5.0 + * + * @param array $image_sizes An array of intermediate image sizes. Defaults + * are 'thumbnail', 'medium', 'medium_large', 'large'. + */ return apply_filters( 'intermediate_image_sizes', $image_sizes ); } @@ -498,62 +735,82 @@ function get_intermediate_image_sizes() { * * A mime icon for files, thumbnail or intermediate size for images. * + * The returned array contains four values: the URL of the attachment image src, + * the width of the image file, the height of the image file, and a boolean + * representing whether the returned array describes an intermediate (generated) + * image size or the original, full-sized upload. + * * @since 2.5.0 * - * @param int $attachment_id Image attachment ID. - * @param string $size Optional, default is 'thumbnail'. - * @param bool $icon Optional, default is false. Whether it is an icon. - * @return bool|array Returns an array (url, width, height), or false, if no image is available. + * @param int $attachment_id Image attachment ID. + * @param string|array $size Optional. Image size. Accepts any valid image size, or an array of width + * and height values in pixels (in that order). Default 'thumbnail'. + * @param bool $icon Optional. Whether the image should be treated as an icon. Default false. + * @return false|array Returns an array (url, width, height, is_intermediate), or false, if no image is available. */ -function wp_get_attachment_image_src($attachment_id, $size='thumbnail', $icon = false) { - +function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon = false ) { // get a thumbnail or intermediate image if there is one - if ( $image = image_downsize($attachment_id, $size) ) - return $image; + $image = image_downsize( $attachment_id, $size ); + if ( ! $image ) { + $src = false; - $src = false; + if ( $icon && $src = wp_mime_type_icon( $attachment_id ) ) { + /** This filter is documented in wp-includes/post.php */ + $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' ); + + $src_file = $icon_dir . '/' . wp_basename( $src ); + @list( $width, $height ) = getimagesize( $src_file ); + } - if ( $icon && $src = wp_mime_type_icon($attachment_id) ) { - $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/crystal' ); - $src_file = $icon_dir . '/' . wp_basename($src); - @list($width, $height) = getimagesize($src_file); + if ( $src && $width && $height ) { + $image = array( $src, $width, $height ); + } } - if ( $src && $width && $height ) - return array( $src, $width, $height ); - return false; + /** + * Filter the image src result. + * + * @since 4.3.0 + * + * @param array|false $image Either array with src, width & height, icon src, or false. + * @param int $attachment_id Image attachment ID. + * @param string|array $size Size of image. Image size or array of width and height values + * (in that order). Default 'thumbnail'. + * @param bool $icon Whether the image should be treated as an icon. Default false. + */ + return apply_filters( 'wp_get_attachment_image_src', $image, $attachment_id, $size, $icon ); } /** * Get an HTML img element representing an image attachment * - * While $size will accept an array, it is better to register a size with + * While `$size` will accept an array, it is better to register a size with * add_image_size() so that a cropped version is generated. It's much more * efficient than having to find the closest-sized image and then having the * browser scale down the image. * - * @see add_image_size() - * @uses apply_filters() Calls 'wp_get_attachment_image_attributes' hook on attributes array - * @uses wp_get_attachment_image_src() Gets attachment file URL and dimensions * @since 2.5.0 * - * @param int $attachment_id Image attachment ID. - * @param string $size Optional, default is 'thumbnail'. - * @param bool $icon Optional, default is false. Whether it is an icon. + * @param int $attachment_id Image attachment ID. + * @param string|array $size Optional. Image size. Accepts any valid image size, or an array of width + * and height values in pixels (in that order). Default 'thumbnail'. + * @param bool $icon Optional. Whether the image should be treated as an icon. Default false. + * @param string|array $attr Optional. Attributes for the image markup. Default empty. * @return string HTML img element or empty string on failure. */ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = false, $attr = '') { - $html = ''; $image = wp_get_attachment_image_src($attachment_id, $size, $icon); if ( $image ) { list($src, $width, $height) = $image; $hwstring = image_hwstring($width, $height); - if ( is_array($size) ) - $size = join('x', $size); + $size_class = $size; + if ( is_array( $size_class ) ) { + $size_class = join( 'x', $size_class ); + } $attachment = get_post($attachment_id); $default_attr = array( 'src' => $src, - 'class' => "attachment-$size", + 'class' => "attachment-$size_class size-$size_class", 'alt' => trim(strip_tags( get_post_meta($attachment_id, '_wp_attachment_image_alt', true) )), // Use Alt field first ); if ( empty($default_attr['alt']) ) @@ -561,8 +818,38 @@ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = fa if ( empty($default_attr['alt']) ) $default_attr['alt'] = trim(strip_tags( $attachment->post_title )); // Finally, use the title - $attr = wp_parse_args($attr, $default_attr); - $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment ); + $attr = wp_parse_args( $attr, $default_attr ); + + // Generate 'srcset' and 'sizes' if not already present. + if ( empty( $attr['srcset'] ) ) { + $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true ); + + if ( is_array( $image_meta ) ) { + $size_array = array( absint( $width ), absint( $height ) ); + $srcset = wp_calculate_image_srcset( $size_array, $src, $image_meta, $attachment_id ); + $sizes = wp_calculate_image_sizes( $size_array, $src, $image_meta, $attachment_id ); + + if ( $srcset && ( $sizes || ! empty( $attr['sizes'] ) ) ) { + $attr['srcset'] = $srcset; + + if ( empty( $attr['sizes'] ) ) { + $attr['sizes'] = $sizes; + } + } + } + } + + /** + * Filter the list of attachment image attributes. + * + * @since 2.8.0 + * + * @param array $attr Attributes for the image markup. + * @param WP_Post $attachment Image attachment post. + * @param string|array $size Requested size. Image size or array of width and height values + * (in that order). Default 'thumbnail'. + */ + $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment, $size ); $attr = array_map( 'esc_attr', $attr ); $html = rtrim(" $value ) { @@ -575,187 +862,830 @@ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = fa } /** - * Adds a 'wp-post-image' class to post thumbnails - * Uses the begin_fetch_post_thumbnail_html and end_fetch_post_thumbnail_html action hooks to - * dynamically add/remove itself so as to only filter post thumbnails + * Get the URL of an image attachment. * - * @since 2.9.0 - * @param array $attr Attributes including src, class, alt, title - * @return array + * @since 4.4.0 + * + * @param int $attachment_id Image attachment ID. + * @param string|array $size Optional. Image size to retrieve. Accepts any valid image size, or an array + * of width and height values in pixels (in that order). Default 'thumbnail'. + * @param bool $icon Optional. Whether the image should be treated as an icon. Default false. + * @return string|false Attachment URL or false if no image is available. */ -function _wp_post_thumbnail_class_filter( $attr ) { - $attr['class'] .= ' wp-post-image'; - return $attr; +function wp_get_attachment_image_url( $attachment_id, $size = 'thumbnail', $icon = false ) { + $image = wp_get_attachment_image_src( $attachment_id, $size, $icon ); + return isset( $image['0'] ) ? $image['0'] : false; } /** - * Adds _wp_post_thumbnail_class_filter to the wp_get_attachment_image_attributes filter + * Get the attachment path relative to the upload directory. * - * @since 2.9.0 + * @since 4.4.1 + * @access private + * + * @param string $file Attachment file name. + * @return string Attachment path relative to the upload directory. */ -function _wp_post_thumbnail_class_filter_add( $attr ) { - add_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' ); +function _wp_get_attachment_relative_path( $file ) { + $dirname = dirname( $file ); + + if ( '.' === $dirname ) { + return ''; + } + + if ( false !== strpos( $dirname, 'wp-content/uploads' ) ) { + // Get the directory name relative to the upload directory (back compat for pre-2.7 uploads) + $dirname = substr( $dirname, strpos( $dirname, 'wp-content/uploads' ) + 18 ); + $dirname = ltrim( $dirname, '/' ); + } + + return $dirname; } /** - * Removes _wp_post_thumbnail_class_filter from the wp_get_attachment_image_attributes filter + * Get the image size as array from its meta data. * - * @since 2.9.0 + * Used for responsive images. + * + * @since 4.4.0 + * @access private + * + * @param string $size_name Image size. Accepts any valid image size name ('thumbnail', 'medium', etc.). + * @param array $image_meta The image meta data. + * @return array|bool Array of width and height values in pixels (in that order) + * or false if the size doesn't exist. */ -function _wp_post_thumbnail_class_filter_remove( $attr ) { - remove_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' ); -} +function _wp_get_image_size_from_meta( $size_name, $image_meta ) { + if ( $size_name === 'full' ) { + return array( + absint( $image_meta['width'] ), + absint( $image_meta['height'] ), + ); + } elseif ( ! empty( $image_meta['sizes'][$size_name] ) ) { + return array( + absint( $image_meta['sizes'][$size_name]['width'] ), + absint( $image_meta['sizes'][$size_name]['height'] ), + ); + } -add_shortcode('wp_caption', 'img_caption_shortcode'); -add_shortcode('caption', 'img_caption_shortcode'); + return false; +} /** - * The Caption shortcode. + * Retrieves the value for an image attachment's 'srcset' attribute. * - * Allows a plugin to replace the content that would otherwise be returned. The - * filter is 'img_caption_shortcode' and passes an empty string, the attr - * parameter and the content parameter values. + * @since 4.4.0 * - * The supported attributes for the shortcode are 'id', 'align', 'width', and - * 'caption'. + * @see wp_calculate_image_srcset() * - * @since 2.6.0 + * @param int $attachment_id Image attachment ID. + * @param array|string $size Optional. Image size. Accepts any valid image size, or an array of + * width and height values in pixels (in that order). Default 'medium'. + * @param array $image_meta Optional. The image meta data as returned by 'wp_get_attachment_metadata()'. + * Default null. + * @return string|bool A 'srcset' value string or false. + */ +function wp_get_attachment_image_srcset( $attachment_id, $size = 'medium', $image_meta = null ) { + if ( ! $image = wp_get_attachment_image_src( $attachment_id, $size ) ) { + return false; + } + + if ( ! is_array( $image_meta ) ) { + $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true ); + } + + $image_src = $image[0]; + $size_array = array( + absint( $image[1] ), + absint( $image[2] ) + ); + + return wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id ); +} + +/** + * A helper function to calculate the image sources to include in a 'srcset' attribute. * - * @param array $attr Attributes attributed to the shortcode. - * @param string $content Optional. Shortcode content. - * @return string + * @since 4.4.0 + * + * @param array $size_array Array of width and height values in pixels (in that order). + * @param string $image_src The 'src' of the image. + * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. + * @param int $attachment_id Optional. The image attachment ID to pass to the filter. Default 0. + * @return string|bool The 'srcset' attribute value. False on error or when only one source exists. */ -function img_caption_shortcode($attr, $content = null) { - // New-style shortcode with the caption inside the shortcode with the link and image tags. - if ( ! isset( $attr['caption'] ) ) { - if ( preg_match( '#((?:]+>\s*)?]+>(?:\s*)?)(.*)#is', $content, $matches ) ) { - $content = $matches[1]; - $attr['caption'] = trim( $matches[2] ); - } +function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id = 0 ) { + /** + * Let plugins pre-filter the image meta to be able to fix inconsistencies in the stored data. + * + * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. + * @param array $size_array Array of width and height values in pixels (in that order). + * @param string $image_src The 'src' of the image. + * @param int $attachment_id The image attachment ID or 0 if not supplied. + */ + $image_meta = apply_filters( 'wp_calculate_image_srcset_meta', $image_meta, $size_array, $image_src, $attachment_id ); + + if ( empty( $image_meta['sizes'] ) || ! isset( $image_meta['file'] ) || strlen( $image_meta['file'] ) < 4 ) { + return false; } - // Allow plugins/themes to override the default caption template. - $output = apply_filters('img_caption_shortcode', '', $attr, $content); - if ( $output != '' ) - return $output; + $image_sizes = $image_meta['sizes']; - extract(shortcode_atts(array( - 'id' => '', - 'align' => 'alignnone', - 'width' => '', - 'caption' => '' - ), $attr)); + // Get the width and height of the image. + $image_width = (int) $size_array[0]; + $image_height = (int) $size_array[1]; - if ( 1 > (int) $width || empty($caption) ) - return $content; + // Bail early if error/no width. + if ( $image_width < 1 ) { + return false; + } + + $image_basename = wp_basename( $image_meta['file'] ); + + /* + * WordPress flattens animated GIFs into one frame when generating intermediate sizes. + * To avoid hiding animation in user content, if src is a full size GIF, a srcset attribute is not generated. + * If src is an intermediate size GIF, the full size is excluded from srcset to keep a flattened GIF from becoming animated. + */ + if ( ! isset( $image_sizes['thumbnail']['mime-type'] ) || 'image/gif' !== $image_sizes['thumbnail']['mime-type'] ) { + $image_sizes['full'] = array( + 'width' => $image_meta['width'], + 'height' => $image_meta['height'], + 'file' => $image_basename, + ); + } elseif ( strpos( $image_src, $image_meta['file'] ) ) { + return false; + } - if ( $id ) $id = 'id="' . esc_attr($id) . '" '; + // Retrieve the uploads sub-directory from the full size image. + $dirname = _wp_get_attachment_relative_path( $image_meta['file'] ); - return '
' - . do_shortcode( $content ) . '

' . $caption . '

'; -} + if ( $dirname ) { + $dirname = trailingslashit( $dirname ); + } -add_shortcode('gallery', 'gallery_shortcode'); + $upload_dir = wp_get_upload_dir(); + $image_baseurl = trailingslashit( $upload_dir['baseurl'] ) . $dirname; + + /* + * If currently on HTTPS, prefer HTTPS URLs when we know they're supported by the domain + * (which is to say, when they share the domain name of the current request). + */ + if ( is_ssl() && 'https' !== substr( $image_baseurl, 0, 5 ) && parse_url( $image_baseurl, PHP_URL_HOST ) === $_SERVER['HTTP_HOST'] ) { + $image_baseurl = set_url_scheme( $image_baseurl, 'https' ); + } + + /* + * Images that have been edited in WordPress after being uploaded will + * contain a unique hash. Look for that hash and use it later to filter + * out images that are leftovers from previous versions. + */ + $image_edited = preg_match( '/-e[0-9]{13}/', wp_basename( $image_src ), $image_edit_hash ); + + /** + * Filter the maximum image width to be included in a 'srcset' attribute. + * + * @since 4.4.0 + * + * @param int $max_width The maximum image width to be included in the 'srcset'. Default '1600'. + * @param array $size_array Array of width and height values in pixels (in that order). + */ + $max_srcset_image_width = apply_filters( 'max_srcset_image_width', 1600, $size_array ); + + // Array to hold URL candidates. + $sources = array(); + + /** + * To make sure the ID matches our image src, we will check to see if any sizes in our attachment + * meta match our $image_src. If no matches are found we don't return a srcset to avoid serving + * an incorrect image. See #35045. + */ + $src_matched = false; + + /* + * Loop through available images. Only use images that are resized + * versions of the same edit. + */ + foreach ( $image_sizes as $image ) { + $is_src = false; + + // Check if image meta isn't corrupted. + if ( ! is_array( $image ) ) { + continue; + } + + // If the file name is part of the `src`, we've confirmed a match. + if ( ! $src_matched && false !== strpos( $image_src, $dirname . $image['file'] ) ) { + $src_matched = $is_src = true; + } + + // Filter out images that are from previous edits. + if ( $image_edited && ! strpos( $image['file'], $image_edit_hash[0] ) ) { + continue; + } + + /* + * Filter out images that are wider than '$max_srcset_image_width' unless + * that file is in the 'src' attribute. + */ + if ( $max_srcset_image_width && $image['width'] > $max_srcset_image_width && ! $is_src ) { + continue; + } + + /** + * To check for varying crops, we calculate the expected size of the smaller + * image if the larger were constrained by the width of the smaller and then + * see if it matches what we're expecting. + */ + if ( $image_width > $image['width'] ) { + $constrained_size = wp_constrain_dimensions( $image_width, $image_height, $image['width'] ); + $expected_size = array( $image['width'], $image['height'] ); + } else { + $constrained_size = wp_constrain_dimensions( $image['width'], $image['height'], $image_width ); + $expected_size = array( $image_width, $image_height ); + } + + // If the image dimensions are within 1px of the expected size, use it. + if ( abs( $constrained_size[0] - $expected_size[0] ) <= 1 && abs( $constrained_size[1] - $expected_size[1] ) <= 1 ) { + // Add the URL, descriptor, and value to the sources array to be returned. + $source = array( + 'url' => $image_baseurl . $image['file'], + 'descriptor' => 'w', + 'value' => $image['width'], + ); + + // The 'src' image has to be the first in the 'srcset', because of a bug in iOS8. See #35030. + if ( $is_src ) { + $sources = array( $image['width'] => $source ) + $sources; + } else { + $sources[ $image['width'] ] = $source; + } + } + } + + /** + * Filter an image's 'srcset' sources. + * + * @since 4.4.0 + * + * @param array $sources { + * One or more arrays of source data to include in the 'srcset'. + * + * @type array $width { + * @type string $url The URL of an image source. + * @type string $descriptor The descriptor type used in the image candidate string, + * either 'w' or 'x'. + * @type int $value The source width if paired with a 'w' descriptor, or a + * pixel density value if paired with an 'x' descriptor. + * } + * } + * @param array $size_array Array of width and height values in pixels (in that order). + * @param string $image_src The 'src' of the image. + * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. + * @param int $attachment_id Image attachment ID or 0. + */ + $sources = apply_filters( 'wp_calculate_image_srcset', $sources, $size_array, $image_src, $image_meta, $attachment_id ); + + // Only return a 'srcset' value if there is more than one source. + if ( ! $src_matched || count( $sources ) < 2 ) { + return false; + } + + $srcset = ''; + + foreach ( $sources as $source ) { + $srcset .= $source['url'] . ' ' . $source['value'] . $source['descriptor'] . ', '; + } + + return rtrim( $srcset, ', ' ); +} /** - * The Gallery shortcode. + * Retrieves the value for an image attachment's 'sizes' attribute. * - * This implements the functionality of the Gallery Shortcode for displaying - * WordPress images on a post. + * @since 4.4.0 * - * @since 2.5.0 + * @see wp_calculate_image_sizes() * - * @param array $attr Attributes of the shortcode. - * @return string HTML content to display gallery. + * @param int $attachment_id Image attachment ID. + * @param array|string $size Optional. Image size. Accepts any valid image size, or an array of width + * and height values in pixels (in that order). Default 'medium'. + * @param array $image_meta Optional. The image meta data as returned by 'wp_get_attachment_metadata()'. + * Default null. + * @return string|bool A valid source size value for use in a 'sizes' attribute or false. */ -function gallery_shortcode($attr) { - $post = get_post(); - - static $instance = 0; - $instance++; +function wp_get_attachment_image_sizes( $attachment_id, $size = 'medium', $image_meta = null ) { + if ( ! $image = wp_get_attachment_image_src( $attachment_id, $size ) ) { + return false; + } - if ( ! empty( $attr['ids'] ) ) { - // 'ids' is explicitly ordered, unless you specify otherwise. - if ( empty( $attr['orderby'] ) ) - $attr['orderby'] = 'post__in'; - $attr['include'] = $attr['ids']; + if ( ! is_array( $image_meta ) ) { + $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true ); } - // Allow plugins/themes to override the default gallery template. - $output = apply_filters('post_gallery', '', $attr); - if ( $output != '' ) - return $output; + $image_src = $image[0]; + $size_array = array( + absint( $image[1] ), + absint( $image[2] ) + ); + + return wp_calculate_image_sizes( $size_array, $image_src, $image_meta, $attachment_id ); +} + +/** + * Creates a 'sizes' attribute value for an image. + * + * @since 4.4.0 + * + * @param array|string $size Image size to retrieve. Accepts any valid image size, or an array + * of width and height values in pixels (in that order). Default 'medium'. + * @param string $image_src Optional. The URL to the image file. Default null. + * @param array $image_meta Optional. The image meta data as returned by 'wp_get_attachment_metadata()'. + * Default null. + * @param int $attachment_id Optional. Image attachment ID. Either `$image_meta` or `$attachment_id` + * is needed when using the image size name as argument for `$size`. Default 0. + * @return string|bool A valid source size value for use in a 'sizes' attribute or false. + */ +function wp_calculate_image_sizes( $size, $image_src = null, $image_meta = null, $attachment_id = 0 ) { + $width = 0; + + if ( is_array( $size ) ) { + $width = absint( $size[0] ); + } elseif ( is_string( $size ) ) { + if ( ! $image_meta && $attachment_id ) { + $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true ); + } - // We're trusting author input, so let's at least make sure it looks like a valid orderby statement - if ( isset( $attr['orderby'] ) ) { - $attr['orderby'] = sanitize_sql_orderby( $attr['orderby'] ); - if ( !$attr['orderby'] ) - unset( $attr['orderby'] ); + if ( is_array( $image_meta ) ) { + $size_array = _wp_get_image_size_from_meta( $size, $image_meta ); + if ( $size_array ) { + $width = absint( $size_array[0] ); + } + } } - extract(shortcode_atts(array( - 'order' => 'ASC', - 'orderby' => 'menu_order ID', - 'id' => $post->ID, - 'itemtag' => 'dl', - 'icontag' => 'dt', - 'captiontag' => 'dd', - 'columns' => 3, - 'size' => 'thumbnail', - 'include' => '', - 'exclude' => '' - ), $attr)); + if ( ! $width ) { + return false; + } + + // Setup the default 'sizes' attribute. + $sizes = sprintf( '(max-width: %1$dpx) 100vw, %1$dpx', $width ); + + /** + * Filter the output of 'wp_calculate_image_sizes()'. + * + * @since 4.4.0 + * + * @param string $sizes A source size value for use in a 'sizes' attribute. + * @param array|string $size Requested size. Image size or array of width and height values + * in pixels (in that order). + * @param string|null $image_src The URL to the image file or null. + * @param array|null $image_meta The image meta data as returned by wp_get_attachment_metadata() or null. + * @param int $attachment_id Image attachment ID of the original image or 0. + */ + return apply_filters( 'wp_calculate_image_sizes', $sizes, $size, $image_src, $image_meta, $attachment_id ); +} + +/** + * Filters 'img' elements in post content to add 'srcset' and 'sizes' attributes. + * + * @since 4.4.0 + * + * @see wp_image_add_srcset_and_sizes() + * + * @param string $content The raw post content to be filtered. + * @return string Converted content with 'srcset' and 'sizes' attributes added to images. + */ +function wp_make_content_images_responsive( $content ) { + if ( ! preg_match_all( '/]+>/', $content, $matches ) ) { + return $content; + } - $id = intval($id); - if ( 'RAND' == $order ) - $orderby = 'none'; + $selected_images = $attachment_ids = array(); - if ( !empty($include) ) { - $_attachments = get_posts( array('include' => $include, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) ); + foreach( $matches[0] as $image ) { + if ( false === strpos( $image, ' srcset=' ) && preg_match( '/wp-image-([0-9]+)/i', $image, $class_id ) && + ( $attachment_id = absint( $class_id[1] ) ) ) { - $attachments = array(); - foreach ( $_attachments as $key => $val ) { - $attachments[$val->ID] = $_attachments[$key]; + /* + * If exactly the same image tag is used more than once, overwrite it. + * All identical tags will be replaced later with 'str_replace()'. + */ + $selected_images[ $image ] = $attachment_id; + // Overwrite the ID when the same image is included more than once. + $attachment_ids[ $attachment_id ] = true; } - } elseif ( !empty($exclude) ) { - $attachments = get_children( array('post_parent' => $id, 'exclude' => $exclude, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) ); - } else { - $attachments = get_children( array('post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) ); } - if ( empty($attachments) ) - return ''; + if ( count( $attachment_ids ) > 1 ) { + /* + * Warm object cache for use with 'get_post_meta()'. + * + * To avoid making a database call for each image, a single query + * warms the object cache with the meta information for all images. + */ + update_meta_cache( 'post', array_keys( $attachment_ids ) ); + } - if ( is_feed() ) { - $output = "\n"; - foreach ( $attachments as $att_id => $attachment ) - $output .= wp_get_attachment_link($att_id, $size, true) . "\n"; - return $output; + foreach ( $selected_images as $image => $attachment_id ) { + $image_meta = get_post_meta( $attachment_id, '_wp_attachment_metadata', true ); + $content = str_replace( $image, wp_image_add_srcset_and_sizes( $image, $image_meta, $attachment_id ), $content ); } - $itemtag = tag_escape($itemtag); - $captiontag = tag_escape($captiontag); - $icontag = tag_escape($icontag); - $valid_tags = wp_kses_allowed_html( 'post' ); - if ( ! isset( $valid_tags[ $itemtag ] ) ) - $itemtag = 'dl'; - if ( ! isset( $valid_tags[ $captiontag ] ) ) - $captiontag = 'dd'; - if ( ! isset( $valid_tags[ $icontag ] ) ) - $icontag = 'dt'; + return $content; +} - $columns = intval($columns); - $itemwidth = $columns > 0 ? floor(100/$columns) : 100; - $float = is_rtl() ? 'right' : 'left'; +/** + * Adds 'srcset' and 'sizes' attributes to an existing 'img' element. + * + * @since 4.4.0 + * + * @see wp_calculate_image_srcset() + * @see wp_calculate_image_sizes() + * + * @param string $image An HTML 'img' element to be filtered. + * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. + * @param int $attachment_id Image attachment ID. + * @return string Converted 'img' element with 'srcset' and 'sizes' attributes added. + */ +function wp_image_add_srcset_and_sizes( $image, $image_meta, $attachment_id ) { + // Ensure the image meta exists. + if ( empty( $image_meta['sizes'] ) ) { + return $image; + } - $selector = "gallery-{$instance}"; + $image_src = preg_match( '/src="([^"]+)"/', $image, $match_src ) ? $match_src[1] : ''; + list( $image_src ) = explode( '?', $image_src ); - $gallery_style = $gallery_div = ''; - if ( apply_filters( 'use_default_gallery_style', true ) ) - $gallery_style = " - - "; - $size_class = sanitize_html_class( $size ); + /* see gallery_shortcode() in wp-includes/media.php */ + \n\t\t"; + } + + $size_class = sanitize_html_class( $atts['size'] ); $gallery_div = "\n"; + + return $output; +} + +/** + * Outputs the templates used by playlists. + * + * @since 3.9.0 + */ +function wp_underscore_playlist_templates() { +?> + + + + + 'audio', + 'order' => 'ASC', + 'orderby' => 'menu_order ID', + 'id' => $post ? $post->ID : 0, + 'include' => '', + 'exclude' => '', + 'style' => 'light', + 'tracklist' => true, + 'tracknumbers' => true, + 'images' => true, + 'artists' => true + ), $attr, 'playlist' ); + + $id = intval( $atts['id'] ); + + if ( $atts['type'] !== 'audio' ) { + $atts['type'] = 'video'; + } + + $args = array( + 'post_status' => 'inherit', + 'post_type' => 'attachment', + 'post_mime_type' => $atts['type'], + 'order' => $atts['order'], + 'orderby' => $atts['orderby'] + ); + + if ( ! empty( $atts['include'] ) ) { + $args['include'] = $atts['include']; + $_attachments = get_posts( $args ); + + $attachments = array(); + foreach ( $_attachments as $key => $val ) { + $attachments[$val->ID] = $_attachments[$key]; + } + } elseif ( ! empty( $atts['exclude'] ) ) { + $args['post_parent'] = $id; + $args['exclude'] = $atts['exclude']; + $attachments = get_children( $args ); + } else { + $args['post_parent'] = $id; + $attachments = get_children( $args ); + } + + if ( empty( $attachments ) ) { + return ''; + } + + if ( is_feed() ) { + $output = "\n"; + foreach ( $attachments as $att_id => $attachment ) { + $output .= wp_get_attachment_link( $att_id ) . "\n"; + } + return $output; + } + + $outer = 22; // default padding and border of wrapper + + $default_width = 640; + $default_height = 360; + + $theme_width = empty( $content_width ) ? $default_width : ( $content_width - $outer ); + $theme_height = empty( $content_width ) ? $default_height : round( ( $default_height * $theme_width ) / $default_width ); + + $data = array( + 'type' => $atts['type'], + // don't pass strings to JSON, will be truthy in JS + 'tracklist' => wp_validate_boolean( $atts['tracklist'] ), + 'tracknumbers' => wp_validate_boolean( $atts['tracknumbers'] ), + 'images' => wp_validate_boolean( $atts['images'] ), + 'artists' => wp_validate_boolean( $atts['artists'] ), + ); + + $tracks = array(); + foreach ( $attachments as $attachment ) { + $url = wp_get_attachment_url( $attachment->ID ); + $ftype = wp_check_filetype( $url, wp_get_mime_types() ); + $track = array( + 'src' => $url, + 'type' => $ftype['type'], + 'title' => $attachment->post_title, + 'caption' => $attachment->post_excerpt, + 'description' => $attachment->post_content + ); + + $track['meta'] = array(); + $meta = wp_get_attachment_metadata( $attachment->ID ); + if ( ! empty( $meta ) ) { + + foreach ( wp_get_attachment_id3_keys( $attachment ) as $key => $label ) { + if ( ! empty( $meta[ $key ] ) ) { + $track['meta'][ $key ] = $meta[ $key ]; + } + } + + if ( 'video' === $atts['type'] ) { + if ( ! empty( $meta['width'] ) && ! empty( $meta['height'] ) ) { + $width = $meta['width']; + $height = $meta['height']; + $theme_height = round( ( $height * $theme_width ) / $width ); + } else { + $width = $default_width; + $height = $default_height; + } + + $track['dimensions'] = array( + 'original' => compact( 'width', 'height' ), + 'resized' => array( + 'width' => $theme_width, + 'height' => $theme_height + ) + ); + } + } + + if ( $atts['images'] ) { + $thumb_id = get_post_thumbnail_id( $attachment->ID ); + if ( ! empty( $thumb_id ) ) { + list( $src, $width, $height ) = wp_get_attachment_image_src( $thumb_id, 'full' ); + $track['image'] = compact( 'src', 'width', 'height' ); + list( $src, $width, $height ) = wp_get_attachment_image_src( $thumb_id, 'thumbnail' ); + $track['thumb'] = compact( 'src', 'width', 'height' ); + } else { + $src = wp_mime_type_icon( $attachment->ID ); + $width = 48; + $height = 64; + $track['image'] = compact( 'src', 'width', 'height' ); + $track['thumb'] = compact( 'src', 'width', 'height' ); + } + } + + $tracks[] = $track; + } + $data['tracks'] = $tracks; + + $safe_type = esc_attr( $atts['type'] ); + $safe_style = esc_attr( $atts['style'] ); + + ob_start(); + + if ( 1 === $instance ) { + /** + * Print and enqueue playlist scripts, styles, and JavaScript templates. + * + * @since 3.9.0 + * + * @param string $type Type of playlist. Possible values are 'audio' or 'video'. + * @param string $style The 'theme' for the playlist. Core provides 'light' and 'dark'. + */ + do_action( 'wp_playlist_scripts', $atts['type'], $atts['style'] ); + } ?> +
+ +
+ + < controls="controls" preload="none" width="">> +
+
+ + +
+ %1$s', esc_url( $url ) ), $url ); +} + +/** + * Returns a filtered list of WP-supported audio formats. + * + * @since 3.6.0 + * + * @return array Supported audio formats. + */ +function wp_get_audio_extensions() { + /** + * Filter the list of supported audio formats. + * + * @since 3.6.0 + * + * @param array $extensions An array of support audio formats. Defaults are + * 'mp3', 'ogg', 'wma', 'm4a', 'wav'. + */ + return apply_filters( 'wp_audio_extensions', array( 'mp3', 'ogg', 'wma', 'm4a', 'wav' ) ); +} + +/** + * Returns useful keys to use to lookup data from an attachment's stored metadata. + * + * @since 3.9.0 + * + * @param WP_Post $attachment The current attachment, provided for context. + * @param string $context Optional. The context. Accepts 'edit', 'display'. Default 'display'. + * @return array Key/value pairs of field keys to labels. + */ +function wp_get_attachment_id3_keys( $attachment, $context = 'display' ) { + $fields = array( + 'artist' => __( 'Artist' ), + 'album' => __( 'Album' ), + ); + + if ( 'display' === $context ) { + $fields['genre'] = __( 'Genre' ); + $fields['year'] = __( 'Year' ); + $fields['length_formatted'] = _x( 'Length', 'video or audio' ); + } elseif ( 'js' === $context ) { + $fields['bitrate'] = __( 'Bitrate' ); + $fields['bitrate_mode'] = __( 'Bitrate Mode' ); + } + + /** + * Filter the editable list of keys to look up data from an attachment's metadata. + * + * @since 3.9.0 + * + * @param array $fields Key/value pairs of field keys to labels. + * @param WP_Post $attachment Attachment object. + * @param string $context The context. Accepts 'edit', 'display'. Default 'display'. + */ + return apply_filters( 'wp_get_attachment_id3_keys', $fields, $attachment, $context ); +} +/** + * Builds the Audio shortcode output. + * + * This implements the functionality of the Audio Shortcode for displaying + * WordPress mp3s in a post. + * + * @since 3.6.0 + * + * @staticvar int $instance + * + * @param array $attr { + * Attributes of the audio shortcode. + * + * @type string $src URL to the source of the audio file. Default empty. + * @type string $loop The 'loop' attribute for the `