X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9c40b4d36daed9e28e48a5fe9205c32557195a4b..a7cd4c052013b423c6301153f68c7fdbaa2a447b:/wp-includes/media.php diff --git a/wp-includes/media.php b/wp-includes/media.php index 7f349638..c7d092d9 100644 --- a/wp-includes/media.php +++ b/wp-includes/media.php @@ -3,6 +3,7 @@ * WordPress API for media display. * * @package WordPress + * @subpackage Media */ /** @@ -10,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 * 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 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') { - global $content_width; +function image_constrain_size_for_editor( $width, $height, $size = 'medium', $context = null ) { + global $content_width, $_wp_additional_image_sizes; + + if ( ! $context ) + $context = is_admin() ? 'edit' : 'display'; if ( is_array($size) ) { $max_width = $size[0]; @@ -53,14 +59,19 @@ function image_constrain_size_for_editor($width, $height, $size = 'medium') { // 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 + // 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 + // 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 ) $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'] ); + if ( intval($content_width) > 0 && 'edit' == $context ) // Only in admin. Assume that theme authors know what they're doing. + $max_width = min( intval($content_width), $max_width ); } // $size == 'full' has no constraint else { @@ -68,7 +79,19 @@ function image_constrain_size_for_editor($width, $height, $size = 'medium') { $max_height = $height; } - list( $max_width, $max_height ) = apply_filters( 'editor_max_image_size', array( $max_width, $max_height ), $size ); + /** + * 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 ); } @@ -116,11 +139,9 @@ 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 string $size Optional, default is 'medium'. Size of image, can be 'thumbnail'. + * @param array|string $size Optional, default is 'medium'. Size of image, either array or string. * @return bool|array False on failure, array on success. */ function image_downsize($id, $size = 'medium') { @@ -128,18 +149,31 @@ 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, 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); $width = $height = 0; $is_intermediate = false; - - // plugins can use this to provide resize services - if ( $out = apply_filters('image_downsize', false, $id, $size) ) - return $out; + $img_url_basename = wp_basename($img_url); // try for a new style intermediate size if ( $intermediate = image_get_intermediate_size($id, $size) ) { - $img_url = str_replace(basename($img_url), $intermediate['file'], $img_url); + $img_url = str_replace($img_url_basename, $intermediate['file'], $img_url); $width = $intermediate['width']; $height = $intermediate['height']; $is_intermediate = true; @@ -147,13 +181,13 @@ function image_downsize($id, $size = 'medium') { elseif ( $size == 'thumbnail' ) { // fall back to the old thumbnail if ( ($thumb_file = wp_get_attachment_thumb_file($id)) && $info = getimagesize($thumb_file) ) { - $img_url = str_replace(basename($img_url), basename($thumb_file), $img_url); + $img_url = str_replace($img_url_basename, wp_basename($thumb_file), $img_url); $width = $info[0]; $height = $info[1]; $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']; @@ -169,6 +203,86 @@ function image_downsize($id, $size = 'medium') { } +/** + * 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' => $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 ] ); +} + +/** + * 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. * @@ -183,11 +297,6 @@ function image_downsize($id, $size = 'medium') { * * @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. @@ -200,21 +309,45 @@ function get_image_tag($id, $alt, $title, $align, $size='medium') { list( $img_src, $width, $height ) = image_downsize($id, $size); $hwstring = image_hwstring($width, $height); - $class = 'align' . esc_attr($align) .' size-' . esc_attr($size) . ' wp-image-' . $id; - $class = apply_filters('get_image_tag_class', $class, $id, $align, $size); + $title = $title ? 'title="' . esc_attr( $title ) . '" ' : ''; - $html = '' . esc_attr($alt) . ''; + $class = 'align' . esc_attr($align) .' size-' . esc_attr($size) . ' wp-image-' . $id; + /** + * 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 dimentions for a downsampled image. + * Calculates the new dimensions for a downsampled image. * - * Same as {@link wp_shrink_dimensions()}, except the max parameters are - * optional. If either width or height are empty, no constraint is applied on + * If either width or height are empty, no constraint is applied on * that dimension. * * @since 2.5.0 @@ -230,36 +363,76 @@ function wp_constrain_dimensions( $current_width, $current_height, $max_width=0, return array( $current_width, $current_height ); $width_ratio = $height_ratio = 1.0; + $did_width = $did_height = false; - if ( $max_width > 0 && $current_width > 0 && $current_width > $max_width ) + if ( $max_width > 0 && $current_width > 0 && $current_width > $max_width ) { $width_ratio = $max_width / $current_width; + $did_width = true; + } - if ( $max_height > 0 && $current_height > 0 && $current_height > $max_height ) + if ( $max_height > 0 && $current_height > 0 && $current_height > $max_height ) { $height_ratio = $max_height / $current_height; + $did_height = true; + } + + // Calculate the larger/smaller ratios + $smaller_ratio = min( $width_ratio, $height_ratio ); + $larger_ratio = max( $width_ratio, $height_ratio ); + + 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 { + // The larger ratio fits, and is likely to be a more "snug" fit. + $ratio = $larger_ratio; + } - // the smaller ratio is the one we need to fit it to the constraining box - $ratio = min( $width_ratio, $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 ) ); - return array( intval($current_width * $ratio), intval($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 + + // Note: $did_width means it is possible $smaller_ratio == $width_ratio. + if ( $did_width && $w == $max_width - 1 ) { + $w = $max_width; // Round it up + } + + // 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 apply_filters( 'wp_constrain_dimensions', array( $w, $h ), $current_width, $current_height, $max_width, $max_height ); } /** - * Retrieve calculated resized dimensions for use in imagecopyresampled(). + * Retrieve 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 * - * @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) { +function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = false) { if ($orig_w <= 0 || $orig_h <= 0) return false; @@ -267,27 +440,67 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop=false if ($dest_w <= 0 && $dest_h <= 0) return false; + /** + * 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; + if ( $crop ) { // crop the largest possible portion of the original image that we can size to $dest_w x $dest_h $aspect_ratio = $orig_w / $orig_h; $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); - $crop_w = ceil($new_w / $size_ratio); - $crop_h = ceil($new_h / $size_ratio); + $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); - } - else { + 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; $crop_h = $orig_h; @@ -299,97 +512,14 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop=false } // 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 - return array(0, 0, $s_x, $s_y, $new_w, $new_h, $crop_w, $crop_h); - -} - -/** - * Scale down an image to fit a particular size and save a new copy of the image. - * - * The PNG transparency will be preserved using the function, as well as the - * image type. If the file going in is PNG, then the resized image is going to - * be PNG. The only supported image types are PNG, GIF, and JPEG. - * - * Some functionality requires API to exist, so some PHP version may lose out - * support. This is not the fault of WordPress (where functionality is - * downgraded, not actual defects), but of your PHP version. - * - * @since 2.5.0 - * - * @param string $file Image file path. - * @param int $max_w Maximum width to resize to. - * @param int $max_h Maximum height to resize to. - * @param bool $crop Optional. Whether to crop image or resize. - * @param string $suffix Optional. File Suffix. - * @param string $dest_path Optional. New image file path. - * @param int $jpeg_quality Optional, default is 90. Image quality percentage. - * @return mixed WP_Error on failure. String with new destination path. Array of dimensions from {@link image_resize_dimensions()} - */ -function image_resize( $file, $max_w, $max_h, $crop=false, $suffix=null, $dest_path=null, $jpeg_quality=90) { - - $image = wp_load_image( $file ); - if ( !is_resource( $image ) ) - return new WP_Error('error_loading_image', $image); - - list($orig_w, $orig_h, $orig_type) = getimagesize( $file ); - $dims = image_resize_dimensions($orig_w, $orig_h, $max_w, $max_h, $crop); - if (!$dims) - return $dims; - list($dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h) = $dims; - - $newimage = imagecreatetruecolor( $dst_w, $dst_h); + return array( 0, 0, (int) $s_x, (int) $s_y, (int) $new_w, (int) $new_h, (int) $crop_w, (int) $crop_h ); - // preserve PNG transparency - if ( IMAGETYPE_PNG == $orig_type && function_exists( 'imagealphablending' ) && function_exists( 'imagesavealpha' ) ) { - imagealphablending( $newimage, false); - imagesavealpha( $newimage, true); - } - - imagecopyresampled( $newimage, $image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h); - - // we don't need the original in memory anymore - imagedestroy( $image ); - - // $suffix will be appended to the destination filename, just before the extension - if ( !$suffix ) - $suffix = "{$dst_w}x{$dst_h}"; - - $info = pathinfo($file); - $dir = $info['dirname']; - $ext = $info['extension']; - $name = basename($file, ".{$ext}"); - if ( !is_null($dest_path) and $_dest_path = realpath($dest_path) ) - $dir = $_dest_path; - $destfilename = "{$dir}/{$name}-{$suffix}.{$ext}"; - - if ( $orig_type == IMAGETYPE_GIF ) { - if (!imagegif( $newimage, $destfilename ) ) - return new WP_Error('resize_path_invalid', __( 'Resize path invalid' )); - } - elseif ( $orig_type == IMAGETYPE_PNG ) { - if (!imagepng( $newimage, $destfilename ) ) - return new WP_Error('resize_path_invalid', __( 'Resize path invalid' )); - } - else { - // all other formats are converted to jpg - $destfilename = "{$dir}/{$name}-{$suffix}.jpg"; - if (!imagejpeg( $newimage, $destfilename, apply_filters( 'jpeg_quality', $jpeg_quality, 'image_resize' ) ) ) - return new WP_Error('resize_path_invalid', __( 'Resize path invalid' )); - } - - imagedestroy( $newimage ); - - // Set correct file permissions - $stat = stat( dirname( $destfilename )); - $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits - @ chmod( $destfilename, $perms ); - - return $destfilename; } /** @@ -407,16 +537,18 @@ function image_resize( $file, $max_w, $max_h, $crop=false, $suffix=null, $dest_p * @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. */ -function image_make_intermediate_size($file, $width, $height, $crop=false) { +function image_make_intermediate_size( $file, $width, $height, $crop = false ) { if ( $width || $height ) { - $resized_file = image_resize($file, $width, $height, $crop); - if ( !is_wp_error($resized_file) && $resized_file && $info = getimagesize($resized_file) ) { - $resized_file = apply_filters('image_make_intermediate_size', $resized_file); - return array( - 'file' => basename( $resized_file ), - 'width' => $info[0], - 'height' => $info[1], - ); + $editor = wp_get_image_editor( $file ); + + if ( is_wp_error( $editor ) || is_wp_error( $editor->resize( $width, $height, $crop ) ) ) + return false; + + $resized_file = $editor->save(); + + if ( ! is_wp_error( $resized_file ) && $resized_file ) { + unset( $resized_file['path'] ); + return $resized_file; } } return false; @@ -436,7 +568,13 @@ function image_make_intermediate_size($file, $width, $height, $crop=false) { * * The url path will be given, when the $size parameter is a string. * + * If you are passing an array for the $size, you should consider using + * 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. + * * @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. @@ -464,6 +602,13 @@ function image_get_intermediate_size($post_id, $size='thumbnail') { foreach ( $areas 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' ); @@ -485,6 +630,28 @@ function image_get_intermediate_size($post_id, $size='thumbnail') { return $data; } +/** + * Get the available image sizes + * @since 3.0.0 + * @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 + 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 ); +} + /** * Retrieve an image to represent an attachment. * @@ -506,8 +673,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' ); - $src_file = $icon_dir . '/' . basename($src); + /** 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 ( $src && $width && $height ) @@ -518,32 +686,55 @@ function wp_get_attachment_image_src($attachment_id, $size='thumbnail', $icon = /** * Get an HTML img element representing an image attachment * - * @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 + * 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. + * * @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. + * @see add_image_size() + * + * @param int $attachment_id Image attachment ID. + * @param string|array $size Optional. Default 'thumbnail'. + * @param bool $icon Optional. Whether it is an icon. Default false. + * @param string|array $attr Optional. Attributes for the image markup. Default empty string. * @return string HTML img element or empty string on failure. */ -function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = false) { +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); - $attachment =& get_post($attachment_id); - $attr = array( + $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", - 'alt' => trim(strip_tags( $attachment->post_excerpt )), - 'title' => trim(strip_tags( $attachment->post_title )), - ); - $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment ); + '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']) ) + $default_attr['alt'] = trim(strip_tags( $attachment->post_excerpt )); // If not, Use the Caption + 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); + + /** + * 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 ) { @@ -555,6 +746,38 @@ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = fa return $html; } +/** + * 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 + * + * @since 2.9.0 + * @param array $attr Attributes including src, class, alt, title + * @return array + */ +function _wp_post_thumbnail_class_filter( $attr ) { + $attr['class'] .= ' wp-post-image'; + return $attr; +} + +/** + * Adds _wp_post_thumbnail_class_filter to the wp_get_attachment_image_attributes filter + * + * @since 2.9.0 + */ +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 + * + * @since 2.9.0 + */ +function _wp_post_thumbnail_class_filter_remove( $attr ) { + remove_filter( 'wp_get_attachment_image_attributes', '_wp_post_thumbnail_class_filter' ); +} + add_shortcode('wp_caption', 'img_caption_shortcode'); add_shortcode('caption', 'img_caption_shortcode'); @@ -570,31 +793,93 @@ add_shortcode('caption', 'img_caption_shortcode'); * * @since 2.6.0 * - * @param array $attr Attributes attributed to the shortcode. + * @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 Optional. Shortcode content. - * @return string + * @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 ) ) { + $content = $matches[1]; + $attr['caption'] = trim( $matches[2] ); + } + } - // 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; - extract(shortcode_atts(array( - 'id' => '', - 'align' => 'alignnone', - 'width' => '', - 'caption' => '' - ), $attr)); + $atts = shortcode_atts( array( + 'id' => '', + 'align' => 'alignnone', + 'width' => '', + 'caption' => '', + 'class' => '', + ), $attr, 'caption' ); - if ( 1 > (int) $width || empty($caption) ) + $atts['width'] = (int) $atts['width']; + if ( $atts['width'] < 1 || empty( $atts['caption'] ) ) return $content; - if ( $id ) $id = 'id="' . $id . '" '; + 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'] . '
'; + } - return '
' - . do_shortcode( $content ) . '

' . $caption . '

'; + $caption_width = 10 + $atts['width']; + + /** + * Filter the width of an image's caption. + * + * By default, the caption is 10 pixels greater than the width of the image, + * to prevent post content from running up against a floated image. + * + * @since 3.7.0 + * + * @see img_caption_shortcode() + * + * @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 ); + + $style = ''; + if ( $caption_width ) + $style = 'style="width: ' . (int) $caption_width . 'px" '; + + return '
' + . do_shortcode( $content ) . '

' . $atts['caption'] . '

'; } add_shortcode('gallery', 'gallery_shortcode'); @@ -607,182 +892,1105 @@ add_shortcode('gallery', 'gallery_shortcode'); * * @since 2.5.0 * - * @param array $attr Attributes attributed to 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) { - global $post; +function gallery_shortcode( $attr ) { + $post = get_post(); static $instance = 0; $instance++; - // Allow plugins/themes to override the default gallery template. - $output = apply_filters('post_gallery', '', $attr); - if ( $output != '' ) - return $output; + if ( ! empty( $attr['ids'] ) ) { + // 'ids' is explicitly ordered, unless you specify otherwise. + if ( empty( $attr['orderby'] ) ) { + $attr['orderby'] = 'post__in'; + } + $attr['include'] = $attr['ids']; + } - // 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'] ); + /** + * 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 + * + * @see gallery_shortcode() + * + * @param string $output The gallery output. Default empty. + * @param array $attr Attributes of the gallery shortcode. + */ + $output = apply_filters( 'post_gallery', '', $attr ); + if ( $output != '' ) { + return $output; } - extract(shortcode_atts(array( + $html5 = current_theme_supports( 'html5', 'gallery' ); + $atts = shortcode_atts( array( 'order' => 'ASC', 'orderby' => 'menu_order ID', - 'id' => $post->ID, - 'itemtag' => 'dl', - 'icontag' => 'dt', - 'captiontag' => 'dd', + 'id' => $post ? $post->ID : 0, + 'itemtag' => $html5 ? 'figure' : 'dl', + 'icontag' => $html5 ? 'div' : 'dt', + 'captiontag' => $html5 ? 'figcaption' : 'dd', 'columns' => 3, - 'size' => 'thumbnail' - ), $attr)); + 'size' => 'thumbnail', + 'include' => '', + 'exclude' => '', + 'link' => '' + ), $attr, 'gallery' ); + + $id = intval( $atts['id'] ); + + 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'] ) ); - $id = intval($id); - $attachments = get_children( array('post_parent' => $id, 'post_status' => 'inherit', 'post_type' => 'attachment', 'post_mime_type' => 'image', 'order' => $order, 'orderby' => $orderby) ); + $attachments = array(); + foreach ( $_attachments as $key => $val ) { + $attachments[$val->ID] = $_attachments[$key]; + } + } 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' => $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); - $columns = intval($columns); + $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 ] ) ) { + $itemtag = 'dl'; + } + if ( ! isset( $valid_tags[ $captiontag ] ) ) { + $captiontag = 'dd'; + } + if ( ! isset( $valid_tags[ $icontag ] ) ) { + $icontag = 'dt'; + } + + $columns = intval( $atts['columns'] ); $itemwidth = $columns > 0 ? floor(100/$columns) : 100; + $float = is_rtl() ? 'right' : 'left'; $selector = "gallery-{$instance}"; - $output = apply_filters('gallery_style', " + $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 = " - -