3 * WordPress GD Image Editor
6 * @subpackage Image_Editor
10 * WordPress Image Editor Class for Image Manipulation through GD
14 * @subpackage Image_Editor
15 * @uses WP_Image_Editor Extends class
17 class WP_Image_Editor_GD extends WP_Image_Editor {
26 public function __destruct() {
28 // we don't need the original in memory anymore
29 imagedestroy( $this->image );
34 * Checks to see if current environment supports GD.
44 public static function test( $args = array() ) {
45 if ( ! extension_loaded('gd') || ! function_exists('gd_info') )
48 // On some setups GD library does not provide imagerotate() - Ticket #11536
49 if ( isset( $args['methods'] ) &&
50 in_array( 'rotate', $args['methods'] ) &&
51 ! function_exists('imagerotate') ){
60 * Checks to see if editor supports the mime-type specified.
67 * @param string $mime_type
70 public static function supports_mime_type( $mime_type ) {
71 $image_types = imagetypes();
72 switch( $mime_type ) {
74 return ($image_types & IMG_JPG) != 0;
76 return ($image_types & IMG_PNG) != 0;
78 return ($image_types & IMG_GIF) != 0;
85 * Loads image from $this->file into new GD Resource.
90 * @return bool|WP_Error True if loaded successfully; WP_Error on failure.
92 public function load() {
96 if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
97 return new WP_Error( 'error_loading_image', __('File doesn’t exist?'), $this->file );
99 // Set artificially high because GD uses uncompressed images in memory.
100 wp_raise_memory_limit( 'image' );
102 $this->image = @imagecreatefromstring( file_get_contents( $this->file ) );
104 if ( ! is_resource( $this->image ) )
105 return new WP_Error( 'invalid_image', __('File is not an image.'), $this->file );
107 $size = @getimagesize( $this->file );
109 return new WP_Error( 'invalid_image', __('Could not read image size.'), $this->file );
111 if ( function_exists( 'imagealphablending' ) && function_exists( 'imagesavealpha' ) ) {
112 imagealphablending( $this->image, false );
113 imagesavealpha( $this->image, true );
116 $this->update_size( $size[0], $size[1] );
117 $this->mime_type = $size['mime'];
119 return $this->set_quality();
123 * Sets or updates current image size.
132 protected function update_size( $width = false, $height = false ) {
134 $width = imagesx( $this->image );
137 $height = imagesy( $this->image );
139 return parent::update_size( $width, $height );
143 * Resizes current image.
144 * Wraps _resize, since _resize returns a GD Resource.
146 * At minimum, either a height or width must be provided.
147 * If one of the two is set to null, the resize will
148 * maintain aspect ratio according to the provided dimension.
153 * @param int|null $max_w Image width.
154 * @param int|null $max_h Image height.
156 * @return true|WP_Error
158 public function resize( $max_w, $max_h, $crop = false ) {
159 if ( ( $this->size['width'] == $max_w ) && ( $this->size['height'] == $max_h ) )
162 $resized = $this->_resize( $max_w, $max_h, $crop );
164 if ( is_resource( $resized ) ) {
165 imagedestroy( $this->image );
166 $this->image = $resized;
169 } elseif ( is_wp_error( $resized ) )
172 return new WP_Error( 'image_resize_error', __('Image resize failed.'), $this->file );
179 * @param bool|array $crop
180 * @return resource|WP_Error
182 protected function _resize( $max_w, $max_h, $crop = false ) {
183 $dims = image_resize_dimensions( $this->size['width'], $this->size['height'], $max_w, $max_h, $crop );
185 return new WP_Error( 'error_getting_dimensions', __('Could not calculate resized image dimensions'), $this->file );
187 list( $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h ) = $dims;
189 $resized = wp_imagecreatetruecolor( $dst_w, $dst_h );
190 imagecopyresampled( $resized, $this->image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
192 if ( is_resource( $resized ) ) {
193 $this->update_size( $dst_w, $dst_h );
197 return new WP_Error( 'image_resize_error', __('Image resize failed.'), $this->file );
201 * Resize multiple images from a single source.
206 * @param array $sizes {
207 * An array of image size arrays. Default sizes are 'small', 'medium', 'medium_large', 'large'.
209 * Either a height or width must be provided.
210 * If one of the two is set to null, the resize will
211 * maintain aspect ratio according to the provided dimension.
213 * @type array $size {
214 * Array of height, width values, and whether to crop.
216 * @type int $width Image width. Optional if `$height` is specified.
217 * @type int $height Image height. Optional if `$width` is specified.
218 * @type bool $crop Optional. Whether to crop the image. Default false.
221 * @return array An array of resized images' metadata by size.
223 public function multi_resize( $sizes ) {
225 $orig_size = $this->size;
227 foreach ( $sizes as $size => $size_data ) {
228 if ( ! isset( $size_data['width'] ) && ! isset( $size_data['height'] ) ) {
232 if ( ! isset( $size_data['width'] ) ) {
233 $size_data['width'] = null;
235 if ( ! isset( $size_data['height'] ) ) {
236 $size_data['height'] = null;
239 if ( ! isset( $size_data['crop'] ) ) {
240 $size_data['crop'] = false;
243 $image = $this->_resize( $size_data['width'], $size_data['height'], $size_data['crop'] );
244 $duplicate = ( ( $orig_size['width'] == $size_data['width'] ) && ( $orig_size['height'] == $size_data['height'] ) );
246 if ( ! is_wp_error( $image ) && ! $duplicate ) {
247 $resized = $this->_save( $image );
249 imagedestroy( $image );
251 if ( ! is_wp_error( $resized ) && $resized ) {
252 unset( $resized['path'] );
253 $metadata[$size] = $resized;
257 $this->size = $orig_size;
269 * @param int $src_x The start x position to crop from.
270 * @param int $src_y The start y position to crop from.
271 * @param int $src_w The width to crop.
272 * @param int $src_h The height to crop.
273 * @param int $dst_w Optional. The destination width.
274 * @param int $dst_h Optional. The destination height.
275 * @param bool $src_abs Optional. If the source crop points are absolute.
276 * @return bool|WP_Error
278 public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false ) {
279 // If destination width/height isn't specified, use same as
280 // width/height from source.
286 $dst = wp_imagecreatetruecolor( $dst_w, $dst_h );
293 if ( function_exists( 'imageantialias' ) )
294 imageantialias( $dst, true );
296 imagecopyresampled( $dst, $this->image, 0, 0, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
298 if ( is_resource( $dst ) ) {
299 imagedestroy( $this->image );
301 $this->update_size();
305 return new WP_Error( 'image_crop_error', __('Image crop failed.'), $this->file );
309 * Rotates current image counter-clockwise by $angle.
310 * Ported from image-edit.php
315 * @param float $angle
316 * @return true|WP_Error
318 public function rotate( $angle ) {
319 if ( function_exists('imagerotate') ) {
320 $transparency = imagecolorallocatealpha( $this->image, 255, 255, 255, 127 );
321 $rotated = imagerotate( $this->image, $angle, $transparency );
323 if ( is_resource( $rotated ) ) {
324 imagealphablending( $rotated, true );
325 imagesavealpha( $rotated, true );
326 imagedestroy( $this->image );
327 $this->image = $rotated;
328 $this->update_size();
332 return new WP_Error( 'image_rotate_error', __('Image rotate failed.'), $this->file );
336 * Flips current image.
341 * @param bool $horz Flip along Horizontal Axis
342 * @param bool $vert Flip along Vertical Axis
343 * @return true|WP_Error
345 public function flip( $horz, $vert ) {
346 $w = $this->size['width'];
347 $h = $this->size['height'];
348 $dst = wp_imagecreatetruecolor( $w, $h );
350 if ( is_resource( $dst ) ) {
351 $sx = $vert ? ($w - 1) : 0;
352 $sy = $horz ? ($h - 1) : 0;
353 $sw = $vert ? -$w : $w;
354 $sh = $horz ? -$h : $h;
356 if ( imagecopyresampled( $dst, $this->image, 0, 0, $sx, $sy, $w, $h, $sw, $sh ) ) {
357 imagedestroy( $this->image );
362 return new WP_Error( 'image_flip_error', __('Image flip failed.'), $this->file );
366 * Saves current in-memory image to file.
371 * @param string|null $filename
372 * @param string|null $mime_type
373 * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
375 public function save( $filename = null, $mime_type = null ) {
376 $saved = $this->_save( $this->image, $filename, $mime_type );
378 if ( ! is_wp_error( $saved ) ) {
379 $this->file = $saved['path'];
380 $this->mime_type = $saved['mime-type'];
387 * @param resource $image
388 * @param string|null $filename
389 * @param string|null $mime_type
390 * @return WP_Error|array
392 protected function _save( $image, $filename = null, $mime_type = null ) {
393 list( $filename, $extension, $mime_type ) = $this->get_output_format( $filename, $mime_type );
396 $filename = $this->generate_filename( null, null, $extension );
398 if ( 'image/gif' == $mime_type ) {
399 if ( ! $this->make_image( $filename, 'imagegif', array( $image, $filename ) ) )
400 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
402 elseif ( 'image/png' == $mime_type ) {
403 // convert from full colors to index colors, like original PNG.
404 if ( function_exists('imageistruecolor') && ! imageistruecolor( $image ) )
405 imagetruecolortopalette( $image, false, imagecolorstotal( $image ) );
407 if ( ! $this->make_image( $filename, 'imagepng', array( $image, $filename ) ) )
408 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
410 elseif ( 'image/jpeg' == $mime_type ) {
411 if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, $this->get_quality() ) ) )
412 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
415 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
418 // Set correct file permissions
419 $stat = stat( dirname( $filename ) );
420 $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits
421 @ chmod( $filename, $perms );
424 * Filters the name of the saved image file.
428 * @param string $filename Name of the file.
432 'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
433 'width' => $this->size['width'],
434 'height' => $this->size['height'],
435 'mime-type' => $mime_type,
440 * Returns stream of current image.
445 * @param string $mime_type
448 public function stream( $mime_type = null ) {
449 list( $filename, $extension, $mime_type ) = $this->get_output_format( null, $mime_type );
451 switch ( $mime_type ) {
453 header( 'Content-Type: image/png' );
454 return imagepng( $this->image );
456 header( 'Content-Type: image/gif' );
457 return imagegif( $this->image );
459 header( 'Content-Type: image/jpeg' );
460 return imagejpeg( $this->image, null, $this->get_quality() );
465 * Either calls editor's save function or handles file as a stream.
470 * @param string|stream $filename
471 * @param callable $function
472 * @param array $arguments
475 protected function make_image( $filename, $function, $arguments ) {
476 if ( wp_is_stream( $filename ) )
477 $arguments[1] = null;
479 return parent::make_image( $filename, $function, $arguments );