X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/256a3b381f63716209b3527d0a14442ae570c283..46588ee871246a923d972538dbc93b26f4fda932:/wp-includes/media.php?ds=sidebyside diff --git a/wp-includes/media.php b/wp-includes/media.php index f063e8e8..b69b328d 100644 --- a/wp-includes/media.php +++ b/wp-includes/media.php @@ -11,29 +11,30 @@ * * 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 * 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) + * @param int $width Width of the image in pixels. + * @param int $height Height of the image in pixels. + * @param string|array $size Optional. Size or array of sizes of what the result image + * should be. Accepts any valid image size name. 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 ) @@ -58,10 +59,12 @@ function image_constrain_size_for_editor($width, $height, $size = 'medium', $con // if no width is set, default to the theme content width if available } 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 ) @@ -78,6 +81,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 +111,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,21 +141,32 @@ 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. + * @param int $id Attachment ID for image. + * @param array|string $size Optional. Image size to scale to. Accepts a registered image size + * or flat array of height and width values. Default 'medium'. * @return bool|array False on failure, array on success. */ -function image_downsize($id, $size = 'medium') { +function image_downsize( $id, $size = 'medium' ) { if ( !wp_attachment_is_image($id) ) return false; - // plugins can use this to provide resize services - if ( $out = apply_filters( 'image_downsize', false, $id, $size ) ) + /** + * 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, either array or string. 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); @@ -181,26 +207,87 @@ 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 height and width 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 + * + * @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 ] ); } /** - * Registers an image size for the post thumbnail + * Remove a new image size. + * + * @since 3.9.0 + * + * @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. * * @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 height and width 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 +300,15 @@ 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, or flat array + * of height and width values. 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 +316,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); + + /** + * 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 $size Optional. Default is 'medium'. + */ + $class = apply_filters( 'get_image_tag_class', $class, $id, $align, $size ); $html = '' . esc_attr($alt) . ''; + /** + * 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 $size Optional. Default is 'medium'. + */ $html = apply_filters( 'get_image_tag', $html, $id, $alt, $title, $align, $size ); return $html; } /** - * 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,45 +383,69 @@ 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; + } // Very small dimensions may result in 0, 1 should be the minimum. - $w = max ( 1, intval( $current_width * $ratio ) ); - $h = max ( 1, intval( $current_height * $ratio ) ); + $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. + * + * Calculates dimensions and coordinates for a resized image that fits + * within a specified width and height. * - * 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. + * 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 height and width or resize. + * An array can specify positioning of the crop area. Default false. + * @return bool|array False on failure. Returned array matches parameters for `imagecopyresampled()`. */ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = false) { @@ -325,7 +455,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 height and width 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; @@ -336,12 +481,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); @@ -349,8 +494,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; @@ -363,8 +527,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 @@ -373,7 +538,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 @@ -381,10 +546,11 @@ 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. + * @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 height and width or resize. + * Default false. * @return bool|array False, if no image was created. Metadata array on success. */ function image_make_intermediate_size( $file, $width, $height, $crop = false ) { @@ -405,7 +571,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 @@ -424,18 +590,20 @@ 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. + * @param int $post_id Attachment ID. + * @param array|string $size Optional. Registered image size to retrieve or flat array of height + * and width dimensions. Default 'thumbnail'. * @return bool|array False on failure or array of file path, width, and height on success. */ -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']) ) { + $areas = 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] ) ) { @@ -481,9 +649,13 @@ function image_get_intermediate_size($post_id, $size='thumbnail') { } /** - * 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; @@ -491,6 +663,14 @@ function get_intermediate_image_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', 'large'. + */ return apply_filters( 'intermediate_image_sizes', $image_sizes ); } @@ -501,12 +681,13 @@ function get_intermediate_image_sizes() { * * @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. Registered image size to retrieve the source for or a flat + * array of height and width dimensions. Default 'thumbnail'. + * @param bool $icon Optional. Whether the image should be treated as an icon. Default false. * @return bool|array Returns an array (url, width, height), 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) ) @@ -515,7 +696,9 @@ function wp_get_attachment_image_src($attachment_id, $size='thumbnail', $icon = $src = false; if ( $icon && $src = wp_mime_type_icon($attachment_id) ) { - $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/crystal' ); + /** 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); } @@ -527,20 +710,18 @@ function wp_get_attachment_image_src($attachment_id, $size='thumbnail', $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 mixed $attr Optional, attributes for the image markup. + * @param int $attachment_id Image attachment ID. + * @param string|array $size Optional. Registered image size or flat array of height and width + * dimensions. 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 = '') { @@ -550,12 +731,14 @@ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = fa 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", 'alt' => trim(strip_tags( get_post_meta($attachment_id, '_wp_attachment_image_alt', true) )), // Use Alt field first ); if ( empty($default_attr['alt']) ) @@ -564,7 +747,17 @@ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = fa $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 ); + + /** + * 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. + */ + $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment, $size ); $attr = array_map( 'esc_attr', $attr ); $html = rtrim(" $value ) { @@ -577,13 +770,16 @@ 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 + * Adds a 'wp-post-image' class to post thumbnails. Internal use only. + * + * 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. * + * @ignore * @since 2.9.0 - * @param array $attr Attributes including src, class, alt, title - * @return array + * + * @param array $attr Thumbnail attributes including src, class, alt, title. + * @return array Modified array of attributes including the new 'wp-post-image' class. */ function _wp_post_thumbnail_class_filter( $attr ) { $attr['class'] .= ' wp-post-image'; @@ -591,18 +787,26 @@ function _wp_post_thumbnail_class_filter( $attr ) { } /** - * Adds _wp_post_thumbnail_class_filter to the wp_get_attachment_image_attributes filter + * Adds '_wp_post_thumbnail_class_filter' callback to the 'wp_get_attachment_image_attributes' + * filter hook. Internal use only. * + * @ignore * @since 2.9.0 + * + * @param array $attr Thumbnail attributes including src, class, alt, title. */ function _wp_post_thumbnail_class_filter_add( $attr ) { add_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' ); } /** - * Removes _wp_post_thumbnail_class_filter from the wp_get_attachment_image_attributes filter + * Removes the '_wp_post_thumbnail_class_filter' callback from the 'wp_get_attachment_image_attributes' + * filter hook. Internal use only. * + * @ignore * @since 2.9.0 + * + * @param array $attr Thumbnail attributes including src, class, alt, title. */ function _wp_post_thumbnail_class_filter_remove( $attr ) { remove_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' ); @@ -612,7 +816,7 @@ add_shortcode('wp_caption', 'img_caption_shortcode'); add_shortcode('caption', 'img_caption_shortcode'); /** - * The Caption shortcode. + * Builds the Caption shortcode output. * * 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 @@ -623,11 +827,20 @@ add_shortcode('caption', 'img_caption_shortcode'); * * @since 2.6.0 * - * @param array $attr Attributes attributed to the shortcode. - * @param string $content Optional. Shortcode content. - * @return string + * @param array $attr { + * Attributes of the caption shortcode. + * + * @type string $id ID of the div element for the caption. + * @type string $align Class name that aligns the caption. Default 'alignnone'. Accepts 'alignleft', + * 'aligncenter', alignright', 'alignnone'. + * @type int $width The width of the caption, in pixels. + * @type string $caption The caption text. + * @type string $class Additional class name(s) added to the caption container. + * } + * @param string $content Shortcode content. + * @return string HTML content to display the caption. */ -function img_caption_shortcode($attr, $content = null) { +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 ) ) { @@ -636,8 +849,21 @@ function img_caption_shortcode($attr, $content = null) { } } - // Allow plugins/themes to override the default caption template. - $output = apply_filters('img_caption_shortcode', '', $attr, $content); + /** + * Filter the default caption shortcode output. + * + * If the filtered output isn't empty, it will be used instead of generating + * the default caption template. + * + * @since 2.6.0 + * + * @see img_caption_shortcode() + * + * @param string $output The caption output. Default empty. + * @param array $attr Attributes of the caption shortcode. + * @param string $content The image element, possibly wrapped in a hyperlink. + */ + $output = apply_filters( 'img_caption_shortcode', '', $attr, $content ); if ( $output != '' ) return $output; @@ -645,7 +871,8 @@ function img_caption_shortcode($attr, $content = null) { 'id' => '', 'align' => 'alignnone', 'width' => '', - 'caption' => '' + 'caption' => '', + 'class' => '', ), $attr, 'caption' ); $atts['width'] = (int) $atts['width']; @@ -655,6 +882,13 @@ function img_caption_shortcode($attr, $content = null) { if ( ! empty( $atts['id'] ) ) $atts['id'] = 'id="' . esc_attr( $atts['id'] ) . '" '; + $class = trim( 'wp-caption ' . $atts['align'] . ' ' . $atts['class'] ); + + if ( current_theme_supports( 'html5', 'caption' ) ) { + return '
' + . do_shortcode( $content ) . '
' . $atts['caption'] . '
'; + } + $caption_width = 10 + $atts['width']; /** @@ -665,16 +899,12 @@ function img_caption_shortcode($attr, $content = null) { * * @since 3.7.0 * - * @param int $caption_width Width in pixels. To remove this inline style, return zero. - * @param array $atts { - * The attributes of the caption shortcode. + * @see img_caption_shortcode() * - * @type string 'id' The ID of the div element for the caption. - * @type string 'align' The class name that aligns the caption. Default 'alignnone'. - * @type int 'width' The width of the image being captioned. - * @type string 'caption' The image's caption. - * } - * @param string $content The image element, possibly wrapped in a hyperlink. + * @param int $caption_width Width of the caption in pixels. To remove this inline style, + * return zero. + * @param array $atts Attributes of the caption shortcode. + * @param string $content The image element, possibly wrapped in a hyperlink. */ $caption_width = apply_filters( 'img_caption_shortcode_width', $caption_width, $atts, $content ); @@ -682,24 +912,44 @@ function img_caption_shortcode($attr, $content = null) { if ( $caption_width ) $style = 'style="width: ' . (int) $caption_width . 'px" '; - return '
' + return '
' . do_shortcode( $content ) . '

' . $atts['caption'] . '

'; } add_shortcode('gallery', 'gallery_shortcode'); /** - * The Gallery shortcode. + * Builds the Gallery shortcode output. * * This implements the functionality of the Gallery Shortcode for displaying * WordPress images on a post. * * @since 2.5.0 * - * @param array $attr Attributes of the shortcode. + * @param array $attr { + * Attributes of the gallery shortcode. + * + * @type string $order Order of the images in the gallery. Default 'ASC'. Accepts 'ASC', 'DESC'. + * @type string $orderby The field to use when ordering the images. Default 'menu_order ID'. + * Accepts any valid SQL ORDERBY statement. + * @type int $id Post ID. + * @type string $itemtag HTML tag to use for each image in the gallery. + * Default 'dl', or 'figure' when the theme registers HTML5 gallery support. + * @type string $icontag HTML tag to use for each image's icon. + * Default 'dt', or 'div' when the theme registers HTML5 gallery support. + * @type string $captiontag HTML tag to use for each image's caption. + * Default 'dd', or 'figcaption' when the theme registers HTML5 gallery support. + * @type int $columns Number of columns of images to display. Default 3. + * @type string $size Size of the images to display. Default 'thumbnail'. + * @type string $ids A comma-separated list of IDs of attachments to display. Default empty. + * @type string $include A comma-separated list of IDs of attachments to include. Default empty. + * @type string $exclude A comma-separated list of IDs of attachments to exclude. Default empty. + * @type string $link What to link each image to. Default empty (links to the attachment page). + * Accepts 'file', 'none'. + * } * @return string HTML content to display gallery. */ -function gallery_shortcode($attr) { +function gallery_shortcode( $attr ) { $post = get_post(); static $instance = 0; @@ -707,83 +957,106 @@ function gallery_shortcode($attr) { if ( ! empty( $attr['ids'] ) ) { // 'ids' is explicitly ordered, unless you specify otherwise. - if ( empty( $attr['orderby'] ) ) + if ( empty( $attr['orderby'] ) ) { $attr['orderby'] = 'post__in'; + } $attr['include'] = $attr['ids']; } - // Allow plugins/themes to override the default gallery template. - $output = apply_filters('post_gallery', '', $attr); - if ( $output != '' ) + /** + * Filter the default gallery shortcode output. + * + * If the filtered output isn't empty, it will be used instead of generating + * the default gallery template. + * + * @since 2.5.0 + * @since 4.2.0 The `$instance` parameter was added. + * + * @see gallery_shortcode() + * + * @param string $output The gallery output. Default empty. + * @param array $attr Attributes of the gallery shortcode. + * @param int $instance Unique numeric ID of this gallery shortcode instance. + */ + $output = apply_filters( 'post_gallery', '', $attr, $instance ); + if ( $output != '' ) { return $output; - - // 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'] ); } - extract(shortcode_atts(array( + $html5 = current_theme_supports( 'html5', 'gallery' ); + $atts = shortcode_atts( array( 'order' => 'ASC', 'orderby' => 'menu_order ID', 'id' => $post ? $post->ID : 0, - 'itemtag' => 'dl', - 'icontag' => 'dt', - 'captiontag' => 'dd', + 'itemtag' => $html5 ? 'figure' : 'dl', + 'icontag' => $html5 ? 'div' : 'dt', + 'captiontag' => $html5 ? 'figcaption' : 'dd', 'columns' => 3, 'size' => 'thumbnail', 'include' => '', 'exclude' => '', 'link' => '' - ), $attr, 'gallery')); + ), $attr, 'gallery' ); - $id = intval($id); - if ( 'RAND' == $order ) - $orderby = 'none'; + $id = intval( $atts['id'] ); - if ( !empty($include) ) { - $_attachments = get_posts( array('include' => $include, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) ); + if ( ! empty( $atts['include'] ) ) { + $_attachments = get_posts( array( 'include' => $atts['include'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) ); $attachments = array(); foreach ( $_attachments as $key => $val ) { $attachments[$val->ID] = $_attachments[$key]; } - } 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) ); + } elseif ( ! empty( $atts['exclude'] ) ) { + $attachments = get_children( array( 'post_parent' => $id, 'exclude' => $atts['exclude'], 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) ); } else { - $attachments = get_children( array('post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) ); + $attachments = get_children( array( 'post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $atts['order'], 'orderby' => $atts['orderby'] ) ); } - if ( empty($attachments) ) + if ( empty( $attachments ) ) { return ''; + } if ( is_feed() ) { $output = "\n"; - foreach ( $attachments as $att_id => $attachment ) - $output .= wp_get_attachment_link($att_id, $size, true) . "\n"; + foreach ( $attachments as $att_id => $attachment ) { + $output .= wp_get_attachment_link( $att_id, $atts['size'], true ) . "\n"; + } return $output; } - $itemtag = tag_escape($itemtag); - $captiontag = tag_escape($captiontag); - $icontag = tag_escape($icontag); + $itemtag = tag_escape( $atts['itemtag'] ); + $captiontag = tag_escape( $atts['captiontag'] ); + $icontag = tag_escape( $atts['icontag'] ); $valid_tags = wp_kses_allowed_html( 'post' ); - if ( ! isset( $valid_tags[ $itemtag ] ) ) + if ( ! isset( $valid_tags[ $itemtag ] ) ) { $itemtag = 'dl'; - if ( ! isset( $valid_tags[ $captiontag ] ) ) + } + if ( ! isset( $valid_tags[ $captiontag ] ) ) { $captiontag = 'dd'; - if ( ! isset( $valid_tags[ $icontag ] ) ) + } + if ( ! isset( $valid_tags[ $icontag ] ) ) { $icontag = 'dt'; + } - $columns = intval($columns); + $columns = intval( $atts['columns'] ); $itemwidth = $columns > 0 ? floor(100/$columns) : 100; $float = is_rtl() ? 'right' : 'left'; $selector = "gallery-{$instance}"; - $gallery_style = $gallery_div = ''; - if ( apply_filters( 'use_default_gallery_style', true ) ) + $gallery_style = ''; + + /** + * Filter whether to print default gallery styles. + * + * @since 3.1.0 + * + * @param bool $print Whether to print default gallery styles. + * Defaults to false if the theme supports HTML5 galleries. + * Otherwise, defaults to true. + */ + if ( apply_filters( 'use_default_gallery_style', ! $html5 ) ) { $gallery_style = " "; - $size_class = sanitize_html_class( $size ); + \n\t\t"; + } + + $size_class = sanitize_html_class( $atts['size'] ); $gallery_div = "\n"; return $output; } /** - * Provide a No-JS Flash fallback as a last resort for audio / video + * 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 ); } /** - * Return a filtered list of WP-supported audio formats + * Returns a filtered list of WP-supported audio formats. * * @since 3.6.0 - * @return array + * + * @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' ) ); } /** - * The Audio shortcode. + * 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 * - * @param array $attr Attributes of the shortcode. - * @param string $content Optional. Shortcode content. + * @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 `