X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/3f5685912e89eb3b0534acd85aa0946b1ca2bbe3..refs/tags/wordpress-3.4.2:/wp-includes/media.php diff --git a/wp-includes/media.php b/wp-includes/media.php index 8f0bf3aa..1a933edf 100644 --- a/wp-includes/media.php +++ b/wp-includes/media.php @@ -17,7 +17,7 @@ * 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 + * 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 * 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 @@ -53,9 +53,9 @@ 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')); @@ -64,7 +64,7 @@ function image_constrain_size_for_editor($width, $height, $size = 'medium') { } 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 ) + if ( intval($content_width) > 0 && is_admin() ) // 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 @@ -125,7 +125,7 @@ function image_hwstring($width, $height) { * 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') { @@ -137,6 +137,7 @@ function image_downsize($id, $size = 'medium') { $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) ) @@ -144,7 +145,7 @@ function image_downsize($id, $size = 'medium') { // 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; @@ -152,7 +153,7 @@ 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; @@ -176,16 +177,20 @@ function image_downsize($id, $size = 'medium') { /** * Registers a new image size + * + * @since 2.9.0 */ -function add_image_size( $name, $width = 0, $height = 0, $crop = 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 ); + $_wp_additional_image_sizes[$name] = array( 'width' => absint( $width ), 'height' => absint( $height ), 'crop' => (bool) $crop ); } /** * Registers an image size for the post thumbnail + * + * @since 2.9.0 */ -function set_post_thumbnail_size( $width = 0, $height = 0, $crop = FALSE ) { +function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) { add_image_size( 'post-thumbnail', $width, $height, $crop ); } @@ -231,10 +236,37 @@ function get_image_tag($id, $alt, $title, $align, $size='medium') { } /** - * Calculates the new dimentions for a downsampled image. + * Load an image from a string, if PHP supports it. + * + * @since 2.1.0 + * + * @param string $file Filename of the image to load. + * @return resource The resulting image resource on success, Error string on failure. + */ +function wp_load_image( $file ) { + if ( is_numeric( $file ) ) + $file = get_attached_file( $file ); + + if ( ! file_exists( $file ) ) + return sprintf(__('File “%s” doesn’t exist?'), $file); + + if ( ! function_exists('imagecreatefromstring') ) + return __('The GD image library is not installed.'); + + // Set artificially high because GD uses uncompressed images in memory + @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) ); + $image = imagecreatefromstring( file_get_contents( $file ) ); + + if ( !is_resource( $image ) ) + return sprintf(__('File “%s” is not an image.'), $file); + + return $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 @@ -250,17 +282,41 @@ 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; + } - // the smaller ratio is the one we need to fit it to the constraining box - $ratio = min( $width_ratio, $height_ratio ); - - return array( intval($current_width * $ratio), intval($current_height * $ratio) ); + // Calculate the larger/smaller ratios + $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 ) + // 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; + + $w = intval( $current_width * $ratio ); + $h = 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 + if ( $did_width && $w == $max_width - 1 ) + $w = $max_width; // Round it up + if ( $did_height && $h == $max_height - 1 ) + $h = $max_height; // Round it up + + return array( $w, $h ); } /** @@ -271,13 +327,15 @@ function wp_constrain_dimensions( $current_width, $current_height, $max_width=0, * portion of the image will be cropped out and resized to the required size. * * @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. + * @return bool|array False on failure. Returned array matches parameters for imagecopyresampled() PHP function. */ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = false) { @@ -287,6 +345,11 @@ 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 + $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; @@ -346,16 +409,16 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = fal * @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 $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()} + * @return mixed WP_Error on failure. String with new destination path. */ 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); + return new WP_Error( 'error_loading_image', $image, $file ); $size = @getimagesize( $file ); if ( !$size ) @@ -364,7 +427,7 @@ function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $de $dims = image_resize_dimensions($orig_w, $orig_h, $max_w, $max_h, $crop); if ( !$dims ) - return $dims; + return new WP_Error( 'error_getting_dimensions', __('Could not calculate resized image dimensions') ); list($dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h) = $dims; $newimage = wp_imagecreatetruecolor( $dst_w, $dst_h ); @@ -372,7 +435,7 @@ function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $de imagecopyresampled( $newimage, $image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h); // convert from full colors to index colors, like original PNG. - if ( IMAGETYPE_PNG == $orig_type && !imageistruecolor( $image ) ) + if ( IMAGETYPE_PNG == $orig_type && function_exists('imageistruecolor') && !imageistruecolor( $image ) ) imagetruecolortopalette( $newimage, false, imagecolorstotal( $image ) ); // we don't need the original in memory anymore @@ -385,7 +448,8 @@ function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $de $info = pathinfo($file); $dir = $info['dirname']; $ext = $info['extension']; - $name = basename($file, ".{$ext}"); + $name = wp_basename($file, ".$ext"); + if ( !is_null($dest_path) and $_dest_path = realpath($dest_path) ) $dir = $_dest_path; $destfilename = "{$dir}/{$name}-{$suffix}.{$ext}"; @@ -398,7 +462,8 @@ function image_resize( $file, $max_w, $max_h, $crop = false, $suffix = null, $de return new WP_Error('resize_path_invalid', __( 'Resize path invalid' )); } else { // all other formats are converted to jpg - $destfilename = "{$dir}/{$name}-{$suffix}.jpg"; + if ( 'jpg' != $ext && 'jpeg' != $ext ) + $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' )); } @@ -434,7 +499,7 @@ function image_make_intermediate_size($file, $width, $height, $crop=false) { 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 ), + 'file' => wp_basename( $resized_file ), 'width' => $info[0], 'height' => $info[1], ); @@ -457,7 +522,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. @@ -485,6 +556,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' ); @@ -506,6 +584,20 @@ 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 ) ); + + return apply_filters( 'intermediate_image_sizes', $image_sizes ); +} + /** * Retrieve an image to represent an attachment. * @@ -528,7 +620,7 @@ function wp_get_attachment_image_src($attachment_id, $size='thumbnail', $icon = 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); + $src_file = $icon_dir . '/' . wp_basename($src); @list($width, $height) = getimagesize($src_file); } if ( $src && $width && $height ) @@ -539,6 +631,12 @@ 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 + * 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 @@ -561,9 +659,14 @@ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = fa $default_attr = array( 'src' => $src, 'class' => "attachment-$size", - 'alt' => trim(strip_tags( $attachment->post_excerpt )), + 'alt' => trim(strip_tags( get_post_meta($attachment_id, '_wp_attachment_image_alt', true) )), // Use Alt field first 'title' => trim(strip_tags( $attachment->post_title )), ); + 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); $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment ); $attr = array_map( 'esc_attr', $attr ); @@ -578,11 +681,10 @@ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = fa } /** - * Adds a 'wp-post-image' class to post thumbnail thumbnails + * 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 thumbnail thumbnails + * dynamically add/remove itself so as to only filter post thumbnails * - * @author Mark Jaquith * @since 2.9.0 * @param array $attr Attributes including src, class, alt, title * @return array @@ -595,7 +697,6 @@ function _wp_post_thumbnail_class_filter( $attr ) { /** * Adds _wp_post_thumbnail_class_filter to the wp_get_attachment_image_attributes filter * - * @author Mark Jaquith * @since 2.9.0 */ function _wp_post_thumbnail_class_filter_add( $attr ) { @@ -605,7 +706,6 @@ function _wp_post_thumbnail_class_filter_add( $attr ) { /** * Removes _wp_post_thumbnail_class_filter from the wp_get_attachment_image_attributes filter * - * @author Mark Jaquith * @since 2.9.0 */ function _wp_post_thumbnail_class_filter_remove( $attr ) { @@ -632,6 +732,13 @@ add_shortcode('caption', 'img_caption_shortcode'); * @return string */ 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); @@ -664,11 +771,11 @@ add_shortcode('gallery', 'gallery_shortcode'); * * @since 2.5.0 * - * @param array $attr Attributes attributed to the shortcode. + * @param array $attr Attributes of the shortcode. * @return string HTML content to display gallery. */ function gallery_shortcode($attr) { - global $post, $wp_locale; + global $post; static $instance = 0; $instance++; @@ -731,11 +838,13 @@ function gallery_shortcode($attr) { $captiontag = tag_escape($captiontag); $columns = intval($columns); $itemwidth = $columns > 0 ? floor(100/$columns) : 100; - $float = $wp_locale->text_direction == 'rtl' ? 'right' : 'left'; - + $float = is_rtl() ? 'right' : 'left'; + $selector = "gallery-{$instance}"; - $output = apply_filters('gallery_style', " + $gallery_style = $gallery_div = ''; + if ( apply_filters( 'use_default_gallery_style', true ) ) + $gallery_style = " - -