3 * File contains all the administration image manipulation functions.
6 * @subpackage Administration
10 * Crop an Image to a given size.
14 * @param string|int $src The source file or Attachment ID.
15 * @param int $src_x The start x position to crop from.
16 * @param int $src_y The start y position to crop from.
17 * @param int $src_w The width to crop.
18 * @param int $src_h The height to crop.
19 * @param int $dst_w The destination width.
20 * @param int $dst_h The destination height.
21 * @param int $src_abs Optional. If the source crop points are absolute.
22 * @param string $dst_file Optional. The destination file to write to.
23 * @return string|WP_Error New filepath on success, WP_Error on failure.
25 function wp_crop_image( $src, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false ) {
27 if ( is_numeric( $src ) ) { // Handle int as attachment ID
28 $src_file = get_attached_file( $src );
30 if ( ! file_exists( $src_file ) ) {
31 // If the file doesn't exist, attempt a url fopen on the src link.
32 // This can occur with certain file replication plugins.
33 $src = _load_image_to_edit_path( $src, 'full' );
39 $editor = wp_get_image_editor( $src );
40 if ( is_wp_error( $editor ) )
43 $src = $editor->crop( $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs );
44 if ( is_wp_error( $src ) )
48 $dst_file = str_replace( basename( $src_file ), 'cropped-' . basename( $src_file ), $src_file );
51 * The directory containing the original file may no longer exist when
52 * using a replication plugin.
54 wp_mkdir_p( dirname( $dst_file ) );
56 $dst_file = dirname( $dst_file ) . '/' . wp_unique_filename( dirname( $dst_file ), basename( $dst_file ) );
58 $result = $editor->save( $dst_file );
59 if ( is_wp_error( $result ) )
66 * Generate post thumbnail attachment meta data.
70 * @global array $_wp_additional_image_sizes
72 * @param int $attachment_id Attachment Id to process.
73 * @param string $file Filepath of the Attached image.
74 * @return mixed Metadata for attachment.
76 function wp_generate_attachment_metadata( $attachment_id, $file ) {
77 $attachment = get_post( $attachment_id );
81 if ( preg_match('!^image/!', get_post_mime_type( $attachment )) && file_is_displayable_image($file) ) {
82 $imagesize = getimagesize( $file );
83 $metadata['width'] = $imagesize[0];
84 $metadata['height'] = $imagesize[1];
86 // Make the file path relative to the upload dir.
87 $metadata['file'] = _wp_relative_upload_path($file);
89 // Make thumbnails and other intermediate sizes.
90 global $_wp_additional_image_sizes;
93 foreach ( get_intermediate_image_sizes() as $s ) {
94 $sizes[$s] = array( 'width' => '', 'height' => '', 'crop' => false );
95 if ( isset( $_wp_additional_image_sizes[$s]['width'] ) )
96 $sizes[$s]['width'] = intval( $_wp_additional_image_sizes[$s]['width'] ); // For theme-added sizes
98 $sizes[$s]['width'] = get_option( "{$s}_size_w" ); // For default sizes set in options
99 if ( isset( $_wp_additional_image_sizes[$s]['height'] ) )
100 $sizes[$s]['height'] = intval( $_wp_additional_image_sizes[$s]['height'] ); // For theme-added sizes
102 $sizes[$s]['height'] = get_option( "{$s}_size_h" ); // For default sizes set in options
103 if ( isset( $_wp_additional_image_sizes[$s]['crop'] ) )
104 $sizes[$s]['crop'] = $_wp_additional_image_sizes[$s]['crop']; // For theme-added sizes
106 $sizes[$s]['crop'] = get_option( "{$s}_crop" ); // For default sizes set in options
110 * Filter the image sizes automatically generated when uploading an image.
113 * @since 4.4.0 The `$metadata` argument was addeed
115 * @param array $sizes An associative array of image sizes.
116 * @param array $metadata An associative array of image metadata: width, height, file.
118 $sizes = apply_filters( 'intermediate_image_sizes_advanced', $sizes, $metadata );
121 $editor = wp_get_image_editor( $file );
123 if ( ! is_wp_error( $editor ) )
124 $metadata['sizes'] = $editor->multi_resize( $sizes );
126 $metadata['sizes'] = array();
129 // Fetch additional metadata from EXIF/IPTC.
130 $image_meta = wp_read_image_metadata( $file );
132 $metadata['image_meta'] = $image_meta;
134 } elseif ( wp_attachment_is( 'video', $attachment ) ) {
135 $metadata = wp_read_video_metadata( $file );
136 $support = current_theme_supports( 'post-thumbnails', 'attachment:video' ) || post_type_supports( 'attachment:video', 'thumbnail' );
137 } elseif ( wp_attachment_is( 'audio', $attachment ) ) {
138 $metadata = wp_read_audio_metadata( $file );
139 $support = current_theme_supports( 'post-thumbnails', 'attachment:audio' ) || post_type_supports( 'attachment:audio', 'thumbnail' );
142 if ( $support && ! empty( $metadata['image']['data'] ) ) {
143 // Check for existing cover.
144 $hash = md5( $metadata['image']['data'] );
145 $posts = get_posts( array(
147 'post_type' => 'attachment',
148 'post_mime_type' => $metadata['image']['mime'],
149 'post_status' => 'inherit',
150 'posts_per_page' => 1,
151 'meta_key' => '_cover_hash',
152 'meta_value' => $hash
154 $exists = reset( $posts );
156 if ( ! empty( $exists ) ) {
157 update_post_meta( $attachment_id, '_thumbnail_id', $exists );
160 switch ( $metadata['image']['mime'] ) {
168 $basename = str_replace( '.', '-', basename( $file ) ) . '-image' . $ext;
169 $uploaded = wp_upload_bits( $basename, '', $metadata['image']['data'] );
170 if ( false === $uploaded['error'] ) {
171 $image_attachment = array(
172 'post_mime_type' => $metadata['image']['mime'],
173 'post_type' => 'attachment',
174 'post_content' => '',
177 * Filter the parameters for the attachment thumbnail creation.
181 * @param array $image_attachment An array of parameters to create the thumbnail.
182 * @param array $metadata Current attachment metadata.
183 * @param array $uploaded An array containing the thumbnail path and url.
185 $image_attachment = apply_filters( 'attachment_thumbnail_args', $image_attachment, $metadata, $uploaded );
187 $sub_attachment_id = wp_insert_attachment( $image_attachment, $uploaded['file'] );
188 add_post_meta( $sub_attachment_id, '_cover_hash', $hash );
189 $attach_data = wp_generate_attachment_metadata( $sub_attachment_id, $uploaded['file'] );
190 wp_update_attachment_metadata( $sub_attachment_id, $attach_data );
191 update_post_meta( $attachment_id, '_thumbnail_id', $sub_attachment_id );
196 // Remove the blob of binary data from the array.
198 unset( $metadata['image']['data'] );
202 * Filter the generated attachment meta data.
206 * @param array $metadata An array of attachment meta data.
207 * @param int $attachment_id Current attachment ID.
209 return apply_filters( 'wp_generate_attachment_metadata', $metadata, $attachment_id );
213 * Convert a fraction string to a decimal.
220 function wp_exif_frac2dec($str) {
221 @list( $n, $d ) = explode( '/', $str );
228 * Convert the exif date format to a unix timestamp.
235 function wp_exif_date2ts($str) {
236 @list( $date, $time ) = explode( ' ', trim($str) );
237 @list( $y, $m, $d ) = explode( ':', $date );
239 return strtotime( "{$y}-{$m}-{$d} {$time}" );
243 * Get extended image metadata, exif or iptc as available.
245 * Retrieves the EXIF metadata aperture, credit, camera, caption, copyright, iso
246 * created_timestamp, focal_length, shutter_speed, and title.
248 * The IPTC metadata that is retrieved is APP13, credit, byline, created date
249 * and time, caption, copyright, and title. Also includes FNumber, Model,
250 * DateTimeDigitized, FocalLength, ISOSpeedRatings, and ExposureTime.
252 * @todo Try other exif libraries if available.
255 * @param string $file
256 * @return bool|array False on failure. Image metadata array on success.
258 function wp_read_image_metadata( $file ) {
259 if ( ! file_exists( $file ) )
262 list( , , $sourceImageType ) = getimagesize( $file );
265 * EXIF contains a bunch of data we'll probably never need formatted in ways
266 * that are difficult to use. We'll normalize it and just extract the fields
267 * that are likely to be useful. Fractions and numbers are converted to
268 * floats, dates to unix timestamps, and everything else to strings.
275 'created_timestamp' => 0,
279 'shutter_speed' => 0,
282 'keywords' => array(),
287 * Read IPTC first, since it might contain data not available in exif such
288 * as caption, description etc.
290 if ( is_callable( 'iptcparse' ) ) {
291 getimagesize( $file, $info );
293 if ( ! empty( $info['APP13'] ) ) {
294 $iptc = iptcparse( $info['APP13'] );
296 // Headline, "A brief synopsis of the caption."
297 if ( ! empty( $iptc['2#105'][0] ) ) {
298 $meta['title'] = trim( $iptc['2#105'][0] );
300 * Title, "Many use the Title field to store the filename of the image,
301 * though the field may be used in many ways."
303 } elseif ( ! empty( $iptc['2#005'][0] ) ) {
304 $meta['title'] = trim( $iptc['2#005'][0] );
307 if ( ! empty( $iptc['2#120'][0] ) ) { // description / legacy caption
308 $caption = trim( $iptc['2#120'][0] );
310 mbstring_binary_safe_encoding();
311 $caption_length = strlen( $caption );
312 reset_mbstring_encoding();
314 if ( empty( $meta['title'] ) && $caption_length < 80 ) {
315 // Assume the title is stored in 2:120 if it's short.
316 $meta['title'] = $caption;
319 $meta['caption'] = $caption;
322 if ( ! empty( $iptc['2#110'][0] ) ) // credit
323 $meta['credit'] = trim( $iptc['2#110'][0] );
324 elseif ( ! empty( $iptc['2#080'][0] ) ) // creator / legacy byline
325 $meta['credit'] = trim( $iptc['2#080'][0] );
327 if ( ! empty( $iptc['2#055'][0] ) && ! empty( $iptc['2#060'][0] ) ) // created date and time
328 $meta['created_timestamp'] = strtotime( $iptc['2#055'][0] . ' ' . $iptc['2#060'][0] );
330 if ( ! empty( $iptc['2#116'][0] ) ) // copyright
331 $meta['copyright'] = trim( $iptc['2#116'][0] );
333 if ( ! empty( $iptc['2#025'][0] ) ) { // keywords array
334 $meta['keywords'] = array_values( $iptc['2#025'] );
340 * Filter the image types to check for exif data.
344 * @param array $image_types Image types to check for exif data.
346 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 ) ) ) ) {
347 $exif = @exif_read_data( $file );
349 if ( ! empty( $exif['ImageDescription'] ) ) {
350 mbstring_binary_safe_encoding();
351 $description_length = strlen( $exif['ImageDescription'] );
352 reset_mbstring_encoding();
354 if ( empty( $meta['title'] ) && $description_length < 80 ) {
355 // Assume the title is stored in ImageDescription
356 $meta['title'] = trim( $exif['ImageDescription'] );
359 if ( empty( $meta['caption'] ) && ! empty( $exif['COMPUTED']['UserComment'] ) ) {
360 $meta['caption'] = trim( $exif['COMPUTED']['UserComment'] );
363 if ( empty( $meta['caption'] ) ) {
364 $meta['caption'] = trim( $exif['ImageDescription'] );
366 } elseif ( empty( $meta['caption'] ) && ! empty( $exif['Comments'] ) ) {
367 $meta['caption'] = trim( $exif['Comments'] );
370 if ( empty( $meta['credit'] ) ) {
371 if ( ! empty( $exif['Artist'] ) ) {
372 $meta['credit'] = trim( $exif['Artist'] );
373 } elseif ( ! empty($exif['Author'] ) ) {
374 $meta['credit'] = trim( $exif['Author'] );
378 if ( empty( $meta['copyright'] ) && ! empty( $exif['Copyright'] ) ) {
379 $meta['copyright'] = trim( $exif['Copyright'] );
381 if ( ! empty( $exif['FNumber'] ) ) {
382 $meta['aperture'] = round( wp_exif_frac2dec( $exif['FNumber'] ), 2 );
384 if ( ! empty( $exif['Model'] ) ) {
385 $meta['camera'] = trim( $exif['Model'] );
387 if ( empty( $meta['created_timestamp'] ) && ! empty( $exif['DateTimeDigitized'] ) ) {
388 $meta['created_timestamp'] = wp_exif_date2ts( $exif['DateTimeDigitized'] );
390 if ( ! empty( $exif['FocalLength'] ) ) {
391 $meta['focal_length'] = (string) wp_exif_frac2dec( $exif['FocalLength'] );
393 if ( ! empty( $exif['ISOSpeedRatings'] ) ) {
394 $meta['iso'] = is_array( $exif['ISOSpeedRatings'] ) ? reset( $exif['ISOSpeedRatings'] ) : $exif['ISOSpeedRatings'];
395 $meta['iso'] = trim( $meta['iso'] );
397 if ( ! empty( $exif['ExposureTime'] ) ) {
398 $meta['shutter_speed'] = (string) wp_exif_frac2dec( $exif['ExposureTime'] );
400 if ( ! empty( $exif['Orientation'] ) ) {
401 $meta['orientation'] = $exif['Orientation'];
405 foreach ( array( 'title', 'caption', 'credit', 'copyright', 'camera', 'iso' ) as $key ) {
406 if ( $meta[ $key ] && ! seems_utf8( $meta[ $key ] ) ) {
407 $meta[ $key ] = utf8_encode( $meta[ $key ] );
411 foreach ( $meta['keywords'] as $key => $keyword ) {
412 if ( ! seems_utf8( $keyword ) ) {
413 $meta['keywords'][ $key ] = utf8_encode( $keyword );
417 $meta = wp_kses_post_deep( $meta );
420 * Filter the array of meta data read from an image's exif data.
423 * @since 4.4.0 The `$iptc` parameter was added.
425 * @param array $meta Image meta data.
426 * @param string $file Path to image file.
427 * @param int $sourceImageType Type of image.
428 * @param array $iptc IPTC data.
430 return apply_filters( 'wp_read_image_metadata', $meta, $file, $sourceImageType, $iptc );
435 * Validate that file is an image.
439 * @param string $path File path to test if valid image.
440 * @return bool True if valid image, false if not valid image.
442 function file_is_valid_image($path) {
443 $size = @getimagesize($path);
444 return !empty($size);
448 * Validate that file is suitable for displaying within a web page.
452 * @param string $path File path to test.
453 * @return bool True if suitable, false if not suitable.
455 function file_is_displayable_image($path) {
456 $displayable_image_types = array( IMAGETYPE_GIF, IMAGETYPE_JPEG, IMAGETYPE_PNG, IMAGETYPE_BMP );
458 $info = @getimagesize( $path );
459 if ( empty( $info ) ) {
461 } elseif ( ! in_array( $info[2], $displayable_image_types ) ) {
468 * Filter whether the current image is displayable in the browser.
472 * @param bool $result Whether the image can be displayed. Default true.
473 * @param string $path Path to the image.
475 return apply_filters( 'file_is_displayable_image', $result, $path );
479 * Load an image resource for editing.
483 * @param string $attachment_id Attachment ID.
484 * @param string $mime_type Image mime type.
485 * @param string $size Optional. Image size, defaults to 'full'.
486 * @return resource|false The resulting image resource on success, false on failure.
488 function load_image_to_edit( $attachment_id, $mime_type, $size = 'full' ) {
489 $filepath = _load_image_to_edit_path( $attachment_id, $size );
490 if ( empty( $filepath ) )
493 switch ( $mime_type ) {
495 $image = imagecreatefromjpeg($filepath);
498 $image = imagecreatefrompng($filepath);
501 $image = imagecreatefromgif($filepath);
507 if ( is_resource($image) ) {
509 * Filter the current image being loaded for editing.
513 * @param resource $image Current image.
514 * @param string $attachment_id Attachment ID.
515 * @param string $size Image size.
517 $image = apply_filters( 'load_image_to_edit', $image, $attachment_id, $size );
518 if ( function_exists('imagealphablending') && function_exists('imagesavealpha') ) {
519 imagealphablending($image, false);
520 imagesavealpha($image, true);
527 * Retrieve the path or url of an attachment's attached file.
529 * If the attached file is not present on the local filesystem (usually due to replication plugins),
530 * then the url of the file is returned if url fopen is supported.
535 * @param string $attachment_id Attachment ID.
536 * @param string $size Optional. Image size, defaults to 'full'.
537 * @return string|false File path or url on success, false on failure.
539 function _load_image_to_edit_path( $attachment_id, $size = 'full' ) {
540 $filepath = get_attached_file( $attachment_id );
542 if ( $filepath && file_exists( $filepath ) ) {
543 if ( 'full' != $size && ( $data = image_get_intermediate_size( $attachment_id, $size ) ) ) {
545 * Filter the path to the current image.
547 * The filter is evaluated for all image sizes except 'full'.
551 * @param string $path Path to the current image.
552 * @param string $attachment_id Attachment ID.
553 * @param string $size Size of the image.
555 $filepath = apply_filters( 'load_image_to_edit_filesystempath', path_join( dirname( $filepath ), $data['file'] ), $attachment_id, $size );
557 } elseif ( function_exists( 'fopen' ) && function_exists( 'ini_get' ) && true == ini_get( 'allow_url_fopen' ) ) {
559 * Filter the image URL if not in the local filesystem.
561 * The filter is only evaluated if fopen is enabled on the server.
565 * @param string $image_url Current image URL.
566 * @param string $attachment_id Attachment ID.
567 * @param string $size Size of the image.
569 $filepath = apply_filters( 'load_image_to_edit_attachmenturl', wp_get_attachment_url( $attachment_id ), $attachment_id, $size );
573 * Filter the returned path or URL of the current image.
577 * @param string|bool $filepath File path or URL to current image, or false.
578 * @param string $attachment_id Attachment ID.
579 * @param string $size Size of the image.
581 return apply_filters( 'load_image_to_edit_path', $filepath, $attachment_id, $size );
585 * Copy an existing image file.
590 * @param string $attachment_id Attachment ID.
591 * @return string|false New file path on success, false on failure.
593 function _copy_image_file( $attachment_id ) {
594 $dst_file = $src_file = get_attached_file( $attachment_id );
595 if ( ! file_exists( $src_file ) )
596 $src_file = _load_image_to_edit_path( $attachment_id );
599 $dst_file = str_replace( basename( $dst_file ), 'copy-' . basename( $dst_file ), $dst_file );
600 $dst_file = dirname( $dst_file ) . '/' . wp_unique_filename( dirname( $dst_file ), basename( $dst_file ) );
603 * The directory containing the original file may no longer
604 * exist when using a replication plugin.
606 wp_mkdir_p( dirname( $dst_file ) );
608 if ( ! @copy( $src_file, $dst_file ) )