* File contains all the administration image manipulation functions.
*
* @package WordPress
+ * @subpackage Administration
*/
/**
- * wp_create_thumbnail() - Create a thumbnail from an Image given a maximum side size.
+ * Crop an Image to a given size.
*
- * @package WordPress
- * @param mixed $file Filename of the original image, Or attachment id
- * @param int $max_side Maximum length of a single side for the thumbnail
- * @return string Thumbnail path on success, Error string on failure
- *
- * This function can handle most image file formats which PHP supports.
- * If PHP does not have the functionality to save in a file of the same format, the thumbnail will be created as a jpeg.
- */
-function wp_create_thumbnail( $file, $max_side, $deprecated = '' ) {
-
- $thumbpath = image_resize( $file, $max_side, $max_side );
- return apply_filters( 'wp_create_thumbnail', $thumbpath );
-}
-
-/**
- * wp_crop_image() - Crop an Image to a given size.
- *
- * @package WordPress
- * @internal Missing Long Description
- * @param int $src_file The source file
- * @param int $src_x The start x position to crop from
- * @param int $src_y The start y position to crop from
- * @param int $src_w The width to crop
- * @param int $src_h The height to crop
- * @param int $dst_w The destination width
- * @param int $dst_h The destination height
- * @param int $src_abs If the source crop points are absolute
- * @param int $dst_file The destination file to write to
- * @return string New filepath on success, String error message on failure
+ * @since 2.1.0
*
+ * @param string|int $src The source file or Attachment ID.
+ * @param int $src_x The start x position to crop from.
+ * @param int $src_y The start y position to crop from.
+ * @param int $src_w The width to crop.
+ * @param int $src_h The height to crop.
+ * @param int $dst_w The destination width.
+ * @param int $dst_h The destination height.
+ * @param int $src_abs Optional. If the source crop points are absolute.
+ * @param string $dst_file Optional. The destination file to write to.
+ * @return string|WP_Error|false New filepath on success, WP_Error or false on failure.
*/
-function wp_crop_image( $src_file, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false ) {
- if ( is_numeric( $src_file ) ) // Handle int as attachment ID
- $src_file = get_attached_file( $src_file );
-
- $src = wp_load_image( $src_file );
-
- if ( !is_resource( $src ))
- return $src;
-
- $dst = imagecreatetruecolor( $dst_w, $dst_h );
-
- if ( $src_abs ) {
- $src_w -= $src_x;
- $src_h -= $src_y;
+function wp_crop_image( $src, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false ) {
+ $src_file = $src;
+ if ( is_numeric( $src ) ) { // Handle int as attachment ID
+ $src_file = get_attached_file( $src );
+
+ if ( ! file_exists( $src_file ) ) {
+ // If the file doesn't exist, attempt a url fopen on the src link.
+ // This can occur with certain file replication plugins.
+ $src = _load_image_to_edit_path( $src, 'full' );
+ } else {
+ $src = $src_file;
+ }
}
- if (function_exists('imageantialias'))
- imageantialias( $dst, true );
+ $editor = wp_get_image_editor( $src );
+ if ( is_wp_error( $editor ) )
+ return $editor;
- imagecopyresampled( $dst, $src, 0, 0, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
-
- imagedestroy( $src ); // Free up memory
+ $src = $editor->crop( $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs );
+ if ( is_wp_error( $src ) )
+ return $src;
if ( ! $dst_file )
$dst_file = str_replace( basename( $src_file ), 'cropped-' . basename( $src_file ), $src_file );
- $dst_file = preg_replace( '/\\.[^\\.]+$/', '.jpg', $dst_file );
+ // The directory containing the original file may no longer exist when
+ // using a replication plugin.
+ wp_mkdir_p( dirname( $dst_file ) );
- if ( imagejpeg( $dst, $dst_file ) )
- return $dst_file;
- else
- return false;
+ $dst_file = dirname( $dst_file ) . '/' . wp_unique_filename( dirname( $dst_file ), basename( $dst_file ) );
+
+ $result = $editor->save( $dst_file );
+ return $dst_file;
}
/**
- * wp_generate_attachment_metadata() - Generate post Image attachment Metadata
+ * Generate post thumbnail attachment meta data.
*
- * @package WordPress
- * @internal Missing Long Description
- * @param int $attachment_id Attachment Id to process
- * @param string $file Filepath of the Attached image
- * @return mixed Metadata for attachment
+ * @since 2.1.0
*
+ * @param int $attachment_id Attachment Id to process.
+ * @param string $file Filepath of the Attached image.
+ * @return mixed Metadata for attachment.
*/
function wp_generate_attachment_metadata( $attachment_id, $file ) {
$attachment = get_post( $attachment_id );
$imagesize = getimagesize( $file );
$metadata['width'] = $imagesize[0];
$metadata['height'] = $imagesize[1];
- list($uwidth, $uheight) = wp_shrink_dimensions($metadata['width'], $metadata['height']);
- $metadata['hwstring_small'] = "height='$uheight' width='$uwidth'";
- $metadata['file'] = $file;
+
+ // Make the file path relative to the upload dir
+ $metadata['file'] = _wp_relative_upload_path($file);
// make thumbnails and other intermediate sizes
- $sizes = array('thumbnail', 'medium');
- $sizes = apply_filters('intermediate_image_sizes', $sizes);
-
- foreach ($sizes as $size) {
- $resized = image_make_intermediate_size( $file, get_option("{$size}_size_w"), get_option("{$size}_size_h"), get_option("{$size}_crop") );
- if ( $resized )
- $metadata['sizes'][$size] = $resized;
+ global $_wp_additional_image_sizes;
+
+ foreach ( get_intermediate_image_sizes() as $s ) {
+ $sizes[$s] = array( 'width' => '', 'height' => '', 'crop' => false );
+ if ( isset( $_wp_additional_image_sizes[$s]['width'] ) )
+ $sizes[$s]['width'] = intval( $_wp_additional_image_sizes[$s]['width'] ); // For theme-added sizes
+ else
+ $sizes[$s]['width'] = get_option( "{$s}_size_w" ); // For default sizes set in options
+ if ( isset( $_wp_additional_image_sizes[$s]['height'] ) )
+ $sizes[$s]['height'] = intval( $_wp_additional_image_sizes[$s]['height'] ); // For theme-added sizes
+ else
+ $sizes[$s]['height'] = get_option( "{$s}_size_h" ); // For default sizes set in options
+ if ( isset( $_wp_additional_image_sizes[$s]['crop'] ) )
+ $sizes[$s]['crop'] = intval( $_wp_additional_image_sizes[$s]['crop'] ); // For theme-added sizes
+ else
+ $sizes[$s]['crop'] = get_option( "{$s}_crop" ); // For default sizes set in options
}
-
- // fetch additional metadata from exif/iptc
- $image_meta = wp_read_image_metadata( $file );
- if ($image_meta)
- $metadata['image_meta'] = $image_meta;
-
- }
- return apply_filters( 'wp_generate_attachment_metadata', $metadata );
-}
-/**
- * wp_load_image() - Load an image which PHP Supports.
- *
- * @package WordPress
- * @internal Missing Long Description
- * @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 );
+ $sizes = apply_filters( 'intermediate_image_sizes_advanced', $sizes );
- if ( ! file_exists( $file ) )
- return sprintf(__("File '%s' doesn't exist?"), $file);
+ if ( $sizes ) {
+ $editor = wp_get_image_editor( $file );
- if ( ! function_exists('imagecreatefromstring') )
- return __('The GD image library is not installed.');
+ if ( ! is_wp_error( $editor ) )
+ $metadata['sizes'] = $editor->multi_resize( $sizes );
+ } else {
+ $metadata['sizes'] = array();
+ }
- // Set artificially high because GD uses uncompressed images in memory
- @ini_set('memory_limit', '256M');
- $image = imagecreatefromstring( file_get_contents( $file ) );
+ // fetch additional metadata from exif/iptc
+ $image_meta = wp_read_image_metadata( $file );
+ if ( $image_meta )
+ $metadata['image_meta'] = $image_meta;
- if ( !is_resource( $image ) )
- return sprintf(__("File '%s' is not an image."), $file);
+ }
- return $image;
+ return apply_filters( 'wp_generate_attachment_metadata', $metadata, $attachment_id );
}
/**
- * get_udims() - Calculated the new dimentions for downsampled images
+ * Convert a fraction string to a decimal.
*
- * @package WordPress
- * @internal Missing Description
- * @see wp_shrink_dimensions()
- * @param int $width Current width of the image
- * @param int $height Current height of the image
- * @return mixed Array(height,width) of shrunk dimensions.
+ * @since 2.5.0
*
+ * @param string $str
+ * @return int|float
*/
-function get_udims( $width, $height) {
- return wp_shrink_dimensions( $width, $height );
-}
-/**
- * wp_shrink_dimensions() - Calculates the new dimentions for a downsampled image.
- *
- * @package WordPress
- * @internal Missing Long Description
- * @param int $width Current width of the image
- * @param int $height Current height of the image
- * @param int $wmax Maximum wanted width
- * @param int $hmax Maximum wanted height
- * @return mixed Array(height,width) of shrunk dimensions.
- *
- */
-function wp_shrink_dimensions( $width, $height, $wmax = 128, $hmax = 96 ) {
- return wp_constrain_dimensions( $width, $height, $wmax, $hmax );
-}
-
-// convert a fraction string to a decimal
function wp_exif_frac2dec($str) {
@list( $n, $d ) = explode( '/', $str );
if ( !empty($d) )
return $str;
}
-// convert the exif date format to a unix timestamp
+/**
+ * Convert the exif date format to a unix timestamp.
+ *
+ * @since 2.5.0
+ *
+ * @param string $str
+ * @return int
+ */
function wp_exif_date2ts($str) {
- // seriously, who formats a date like 'YYYY:MM:DD hh:mm:ss'?
@list( $date, $time ) = explode( ' ', trim($str) );
@list( $y, $m, $d ) = explode( ':', $date );
return strtotime( "{$y}-{$m}-{$d} {$time}" );
}
-// get extended image metadata, exif or iptc as available
+/**
+ * Get extended image metadata, exif or iptc as available.
+ *
+ * Retrieves the EXIF metadata aperture, credit, camera, caption, copyright, iso
+ * created_timestamp, focal_length, shutter_speed, and title.
+ *
+ * The IPTC metadata that is retrieved is APP13, credit, byline, created date
+ * and time, caption, copyright, and title. Also includes FNumber, Model,
+ * DateTimeDigitized, FocalLength, ISOSpeedRatings, and ExposureTime.
+ *
+ * @todo Try other exif libraries if available.
+ * @since 2.5.0
+ *
+ * @param string $file
+ * @return bool|array False on failure. Image metadata array on success.
+ */
function wp_read_image_metadata( $file ) {
- if ( !file_exists( $file ) )
+ if ( ! file_exists( $file ) )
return false;
- list(,,$sourceImageType) = getimagesize( $file );
+ list( , , $sourceImageType ) = getimagesize( $file );
- // exif contains a bunch of data we'll probably never need formatted in ways that are difficult to use.
- // We'll normalize it and just extract the fields that are likely to be useful. Fractions and numbers
- // are converted to floats, dates to unix timestamps, and everything else to strings.
+ // exif contains a bunch of data we'll probably never need formatted in ways
+ // that are difficult to use. We'll normalize it and just extract the fields
+ // that are likely to be useful. Fractions and numbers are converted to
+ // floats, dates to unix timestamps, and everything else to strings.
$meta = array(
'aperture' => 0,
'credit' => '',
'title' => '',
);
- // read iptc first, since it might contain data not available in exif such as caption, description etc
- if ( is_callable('iptcparse') ) {
- getimagesize($file, $info);
- if ( !empty($info['APP13']) ) {
- $iptc = iptcparse($info['APP13']);
- if ( !empty($iptc['2#110'][0]) ) // credit
- $meta['credit'] = utf8_encode(trim($iptc['2#110'][0]));
- elseif ( !empty($iptc['2#080'][0]) ) // byline
- $meta['credit'] = utf8_encode(trim($iptc['2#080'][0]));
- if ( !empty($iptc['2#055'][0]) and !empty($iptc['2#060'][0]) ) // created datee and time
- $meta['created_timestamp'] = strtotime($iptc['2#055'][0] . ' ' . $iptc['2#060'][0]);
- if ( !empty($iptc['2#120'][0]) ) // caption
- $meta['caption'] = utf8_encode(trim($iptc['2#120'][0]));
- if ( !empty($iptc['2#116'][0]) ) // copyright
- $meta['copyright'] = utf8_encode(trim($iptc['2#116'][0]));
- if ( !empty($iptc['2#005'][0]) ) // title
- $meta['title'] = utf8_encode(trim($iptc['2#005'][0]));
+ // read iptc first, since it might contain data not available in exif such
+ // as caption, description etc
+ if ( is_callable( 'iptcparse' ) ) {
+ getimagesize( $file, $info );
+
+ if ( ! empty( $info['APP13'] ) ) {
+ $iptc = iptcparse( $info['APP13'] );
+
+ // headline, "A brief synopsis of the caption."
+ if ( ! empty( $iptc['2#105'][0] ) )
+ $meta['title'] = trim( $iptc['2#105'][0] );
+ // title, "Many use the Title field to store the filename of the image, though the field may be used in many ways."
+ elseif ( ! empty( $iptc['2#005'][0] ) )
+ $meta['title'] = trim( $iptc['2#005'][0] );
+
+ if ( ! empty( $iptc['2#120'][0] ) ) { // description / legacy caption
+ $caption = trim( $iptc['2#120'][0] );
+ if ( empty( $meta['title'] ) ) {
+ // Assume the title is stored in 2:120 if it's short.
+ if ( strlen( $caption ) < 80 )
+ $meta['title'] = $caption;
+ else
+ $meta['caption'] = $caption;
+ } elseif ( $caption != $meta['title'] ) {
+ $meta['caption'] = $caption;
+ }
+ }
+
+ if ( ! empty( $iptc['2#110'][0] ) ) // credit
+ $meta['credit'] = trim( $iptc['2#110'][0] );
+ elseif ( ! empty( $iptc['2#080'][0] ) ) // creator / legacy byline
+ $meta['credit'] = trim( $iptc['2#080'][0] );
+
+ if ( ! empty( $iptc['2#055'][0] ) and ! empty( $iptc['2#060'][0] ) ) // created date and time
+ $meta['created_timestamp'] = strtotime( $iptc['2#055'][0] . ' ' . $iptc['2#060'][0] );
+
+ if ( ! empty( $iptc['2#116'][0] ) ) // copyright
+ $meta['copyright'] = trim( $iptc['2#116'][0] );
}
}
// fetch additional info from exif if available
- if ( is_callable('exif_read_data') && in_array($sourceImageType, apply_filters('wp_read_image_metadata_types', array(IMAGETYPE_JPEG, IMAGETYPE_TIFF_II, IMAGETYPE_TIFF_MM)) ) ) {
+ if ( is_callable( 'exif_read_data' ) && in_array( $sourceImageType, apply_filters( 'wp_read_image_metadata_types', array( IMAGETYPE_JPEG, IMAGETYPE_TIFF_II, IMAGETYPE_TIFF_MM ) ) ) ) {
$exif = @exif_read_data( $file );
- if (!empty($exif['FNumber']))
+
+ if ( !empty( $exif['Title'] ) )
+ $meta['title'] = trim( $exif['Title'] );
+
+ if ( ! empty( $exif['ImageDescription'] ) ) {
+ if ( empty( $meta['title'] ) && strlen( $exif['ImageDescription'] ) < 80 ) {
+ // Assume the title is stored in ImageDescription
+ $meta['title'] = trim( $exif['ImageDescription'] );
+ if ( ! empty( $exif['COMPUTED']['UserComment'] ) && trim( $exif['COMPUTED']['UserComment'] ) != $meta['title'] )
+ $meta['caption'] = trim( $exif['COMPUTED']['UserComment'] );
+ } elseif ( trim( $exif['ImageDescription'] ) != $meta['title'] ) {
+ $meta['caption'] = trim( $exif['ImageDescription'] );
+ }
+ } elseif ( ! empty( $exif['Comments'] ) && trim( $exif['Comments'] ) != $meta['title'] ) {
+ $meta['caption'] = trim( $exif['Comments'] );
+ }
+
+ if ( ! empty( $exif['Artist'] ) )
+ $meta['credit'] = trim( $exif['Artist'] );
+ elseif ( ! empty($exif['Author'] ) )
+ $meta['credit'] = trim( $exif['Author'] );
+
+ if ( ! empty( $exif['Copyright'] ) )
+ $meta['copyright'] = trim( $exif['Copyright'] );
+ if ( ! empty($exif['FNumber'] ) )
$meta['aperture'] = round( wp_exif_frac2dec( $exif['FNumber'] ), 2 );
- if (!empty($exif['Model']))
+ if ( ! empty($exif['Model'] ) )
$meta['camera'] = trim( $exif['Model'] );
- if (!empty($exif['DateTimeDigitized']))
- $meta['created_timestamp'] = wp_exif_date2ts($exif['DateTimeDigitized']);
- if (!empty($exif['FocalLength']))
- $meta['focal_length'] = wp_exif_frac2dec( $exif['FocalLength'] );
- if (!empty($exif['ISOSpeedRatings']))
- $meta['iso'] = $exif['ISOSpeedRatings'];
- if (!empty($exif['ExposureTime']))
- $meta['shutter_speed'] = wp_exif_frac2dec( $exif['ExposureTime'] );
+ if ( ! empty($exif['DateTimeDigitized'] ) )
+ $meta['created_timestamp'] = wp_exif_date2ts($exif['DateTimeDigitized'] );
+ if ( ! empty($exif['FocalLength'] ) )
+ $meta['focal_length'] = (string) wp_exif_frac2dec( $exif['FocalLength'] );
+ if ( ! empty($exif['ISOSpeedRatings'] ) ) {
+ $meta['iso'] = is_array( $exif['ISOSpeedRatings'] ) ? reset( $exif['ISOSpeedRatings'] ) : $exif['ISOSpeedRatings'];
+ $meta['iso'] = trim( $meta['iso'] );
+ }
+ if ( ! empty($exif['ExposureTime'] ) )
+ $meta['shutter_speed'] = (string) wp_exif_frac2dec( $exif['ExposureTime'] );
+ }
+
+ foreach ( array( 'title', 'caption', 'credit', 'copyright', 'camera', 'iso' ) as $key ) {
+ if ( $meta[ $key ] && ! seems_utf8( $meta[ $key ] ) )
+ $meta[ $key ] = utf8_encode( $meta[ $key ] );
}
- // FIXME: try other exif libraries if available
return apply_filters( 'wp_read_image_metadata', $meta, $file, $sourceImageType );
}
-// is the file a real image file?
+/**
+ * Validate that file is an image.
+ *
+ * @since 2.5.0
+ *
+ * @param string $path File path to test if valid image.
+ * @return bool True if valid image, false if not valid image.
+ */
function file_is_valid_image($path) {
$size = @getimagesize($path);
return !empty($size);
}
-// is the file an image suitable for displaying within a web page?
+/**
+ * Validate that file is suitable for displaying within a web page.
+ *
+ * @since 2.5.0
+ * @uses apply_filters() Calls 'file_is_displayable_image' on $result and $path.
+ *
+ * @param string $path File path to test.
+ * @return bool True if suitable, false if not suitable.
+ */
function file_is_displayable_image($path) {
$info = @getimagesize($path);
if ( empty($info) )
$result = false;
- elseif ( !in_array($info[2], array(IMAGETYPE_GIF, IMAGETYPE_JPEG, IMAGETYPE_PNG)) )
- // only gif, jpeg and png images can reliably be displayed
- $result = false;
- elseif ( $info['channels'] > 0 && $info['channels'] != 3 ) {
- // some web browsers can't display cmyk or grayscale jpegs
+ elseif ( !in_array($info[2], array(IMAGETYPE_GIF, IMAGETYPE_JPEG, IMAGETYPE_PNG)) ) // only gif, jpeg and png images can reliably be displayed
$result = false;
- }
else
$result = true;
-
+
return apply_filters('file_is_displayable_image', $result, $path);
}
-?>
+/**
+ * Load an image resource for editing.
+ *
+ * @since 2.9.0
+ *
+ * @param string $attachment_id Attachment ID.
+ * @param string $mime_type Image mime type.
+ * @param string $size Optional. Image size, defaults to 'full'.
+ * @return resource|false The resulting image resource on success, false on failure.
+ */
+function load_image_to_edit( $attachment_id, $mime_type, $size = 'full' ) {
+ $filepath = _load_image_to_edit_path( $attachment_id, $size );
+ if ( empty( $filepath ) )
+ return false;
+
+ switch ( $mime_type ) {
+ case 'image/jpeg':
+ $image = imagecreatefromjpeg($filepath);
+ break;
+ case 'image/png':
+ $image = imagecreatefrompng($filepath);
+ break;
+ case 'image/gif':
+ $image = imagecreatefromgif($filepath);
+ break;
+ default:
+ $image = false;
+ break;
+ }
+ if ( is_resource($image) ) {
+ $image = apply_filters('load_image_to_edit', $image, $attachment_id, $size);
+ if ( function_exists('imagealphablending') && function_exists('imagesavealpha') ) {
+ imagealphablending($image, false);
+ imagesavealpha($image, true);
+ }
+ }
+ return $image;
+}
+
+/**
+ * Retrieve the path or url of an attachment's attached file.
+ *
+ * If the attached file is not present on the local filesystem (usually due to replication plugins),
+ * then the url of the file is returned if url fopen is supported.
+ *
+ * @since 3.4.0
+ * @access private
+ *
+ * @param string $attachment_id Attachment ID.
+ * @param string $size Optional. Image size, defaults to 'full'.
+ * @return string|false File path or url on success, false on failure.
+ */
+function _load_image_to_edit_path( $attachment_id, $size = 'full' ) {
+ $filepath = get_attached_file( $attachment_id );
+
+ if ( $filepath && file_exists( $filepath ) ) {
+ if ( 'full' != $size && ( $data = image_get_intermediate_size( $attachment_id, $size ) ) ) {
+ $filepath = apply_filters( 'load_image_to_edit_filesystempath', path_join( dirname( $filepath ), $data['file'] ), $attachment_id, $size );
+ }
+ } elseif ( function_exists( 'fopen' ) && function_exists( 'ini_get' ) && true == ini_get( 'allow_url_fopen' ) ) {
+ $filepath = apply_filters( 'load_image_to_edit_attachmenturl', wp_get_attachment_url( $attachment_id ), $attachment_id, $size );
+ }
+
+ return apply_filters( 'load_image_to_edit_path', $filepath, $attachment_id, $size );
+}
+
+/**
+ * Copy an existing image file.
+ *
+ * @since 3.4.0
+ * @access private
+ *
+ * @param string $attachment_id Attachment ID.
+ * @return string|false New file path on success, false on failure.
+ */
+function _copy_image_file( $attachment_id ) {
+ $dst_file = $src_file = get_attached_file( $attachment_id );
+ if ( ! file_exists( $src_file ) )
+ $src_file = _load_image_to_edit_path( $attachment_id );
+
+ if ( $src_file ) {
+ $dst_file = str_replace( basename( $dst_file ), 'copy-' . basename( $dst_file ), $dst_file );
+ $dst_file = dirname( $dst_file ) . '/' . wp_unique_filename( dirname( $dst_file ), basename( $dst_file ) );
+
+ // The directory containing the original file may no longer exist when
+ // using a replication plugin.
+ wp_mkdir_p( dirname( $dst_file ) );
+
+ if ( ! @copy( $src_file, $dst_file ) )
+ $dst_file = false;
+ } else {
+ $dst_file = false;
+ }
+
+ return $dst_file;
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff