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 {
19 protected $image = false; // GD Resource
21 public function __destruct() {
23 // we don't need the original in memory anymore
24 imagedestroy( $this->image );
29 * Checks to see if current environment supports GD.
36 public static function test( $args = array() ) {
37 if ( ! extension_loaded('gd') || ! function_exists('gd_info') )
40 // On some setups GD library does not provide imagerotate() - Ticket #11536
41 if ( isset( $args['methods'] ) &&
42 in_array( 'rotate', $args['methods'] ) &&
43 ! function_exists('imagerotate') ){
52 * Checks to see if editor supports the mime-type specified.
57 * @param string $mime_type
60 public static function supports_mime_type( $mime_type ) {
61 $image_types = imagetypes();
62 switch( $mime_type ) {
64 return ($image_types & IMG_JPG) != 0;
66 return ($image_types & IMG_PNG) != 0;
68 return ($image_types & IMG_GIF) != 0;
75 * Loads image from $this->file into new GD Resource.
80 * @return boolean|WP_Error True if loaded successfully; WP_Error on failure.
82 public function load() {
86 if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
87 return new WP_Error( 'error_loading_image', __('File doesn’t exist?'), $this->file );
90 * Filter the memory limit allocated for image manipulation.
94 * @param int|string $limit Maximum memory limit to allocate for images. Default WP_MAX_MEMORY_LIMIT.
95 * Accepts an integer (bytes), or a shorthand string notation, such as '256M'.
97 // Set artificially high because GD uses uncompressed images in memory
98 @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
100 $this->image = @imagecreatefromstring( file_get_contents( $this->file ) );
102 if ( ! is_resource( $this->image ) )
103 return new WP_Error( 'invalid_image', __('File is not an image.'), $this->file );
105 $size = @getimagesize( $this->file );
107 return new WP_Error( 'invalid_image', __('Could not read image size.'), $this->file );
109 if ( function_exists( 'imagealphablending' ) && function_exists( 'imagesavealpha' ) ) {
110 imagealphablending( $this->image, false );
111 imagesavealpha( $this->image, true );
114 $this->update_size( $size[0], $size[1] );
115 $this->mime_type = $size['mime'];
121 * Sets or updates current image size.
129 protected function update_size( $width = false, $height = false ) {
131 $width = imagesx( $this->image );
134 $height = imagesy( $this->image );
136 return parent::update_size( $width, $height );
140 * Resizes current image.
141 * Wraps _resize, since _resize returns a GD Resource.
143 * At minimum, either a height or width must be provided.
144 * If one of the two is set to null, the resize will
145 * maintain aspect ratio according to the provided dimension.
150 * @param int|null $max_w Image width.
151 * @param int|null $max_h Image height.
152 * @param boolean $crop
153 * @return boolean|WP_Error
155 public function resize( $max_w, $max_h, $crop = false ) {
156 if ( ( $this->size['width'] == $max_w ) && ( $this->size['height'] == $max_h ) )
159 $resized = $this->_resize( $max_w, $max_h, $crop );
161 if ( is_resource( $resized ) ) {
162 imagedestroy( $this->image );
163 $this->image = $resized;
166 } elseif ( is_wp_error( $resized ) )
169 return new WP_Error( 'image_resize_error', __('Image resize failed.'), $this->file );
172 protected function _resize( $max_w, $max_h, $crop = false ) {
173 $dims = image_resize_dimensions( $this->size['width'], $this->size['height'], $max_w, $max_h, $crop );
175 return new WP_Error( 'error_getting_dimensions', __('Could not calculate resized image dimensions'), $this->file );
177 list( $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h ) = $dims;
179 $resized = wp_imagecreatetruecolor( $dst_w, $dst_h );
180 imagecopyresampled( $resized, $this->image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
182 if ( is_resource( $resized ) ) {
183 $this->update_size( $dst_w, $dst_h );
187 return new WP_Error( 'image_resize_error', __('Image resize failed.'), $this->file );
191 * Resize multiple images from a single source.
196 * @param array $sizes {
197 * An array of image size arrays. Default sizes are 'small', 'medium', 'large'.
199 * Either a height or width must be provided.
200 * If one of the two is set to null, the resize will
201 * maintain aspect ratio according to the provided dimension.
203 * @type array $size {
204 * @type int ['width'] Optional. Image width.
205 * @type int ['height'] Optional. Image height.
206 * @type bool ['crop'] Optional. Whether to crop the image. Default false.
209 * @return array An array of resized images' metadata by size.
211 public function multi_resize( $sizes ) {
213 $orig_size = $this->size;
215 foreach ( $sizes as $size => $size_data ) {
216 if ( ! isset( $size_data['width'] ) && ! isset( $size_data['height'] ) ) {
220 if ( ! isset( $size_data['width'] ) ) {
221 $size_data['width'] = null;
223 if ( ! isset( $size_data['height'] ) ) {
224 $size_data['height'] = null;
227 if ( ! isset( $size_data['crop'] ) ) {
228 $size_data['crop'] = false;
231 $image = $this->_resize( $size_data['width'], $size_data['height'], $size_data['crop'] );
233 if( ! is_wp_error( $image ) ) {
234 $resized = $this->_save( $image );
236 imagedestroy( $image );
238 if ( ! is_wp_error( $resized ) && $resized ) {
239 unset( $resized['path'] );
240 $metadata[$size] = $resized;
244 $this->size = $orig_size;
256 * @param string|int $src The source file or Attachment ID.
257 * @param int $src_x The start x position to crop from.
258 * @param int $src_y The start y position to crop from.
259 * @param int $src_w The width to crop.
260 * @param int $src_h The height to crop.
261 * @param int $dst_w Optional. The destination width.
262 * @param int $dst_h Optional. The destination height.
263 * @param boolean $src_abs Optional. If the source crop points are absolute.
264 * @return boolean|WP_Error
266 public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false ) {
267 // If destination width/height isn't specified, use same as
268 // width/height from source.
274 $dst = wp_imagecreatetruecolor( $dst_w, $dst_h );
281 if ( function_exists( 'imageantialias' ) )
282 imageantialias( $dst, true );
284 imagecopyresampled( $dst, $this->image, 0, 0, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
286 if ( is_resource( $dst ) ) {
287 imagedestroy( $this->image );
289 $this->update_size();
293 return new WP_Error( 'image_crop_error', __('Image crop failed.'), $this->file );
297 * Rotates current image counter-clockwise by $angle.
298 * Ported from image-edit.php
303 * @param float $angle
304 * @return boolean|WP_Error
306 public function rotate( $angle ) {
307 if ( function_exists('imagerotate') ) {
308 $rotated = imagerotate( $this->image, $angle, 0 );
310 if ( is_resource( $rotated ) ) {
311 imagedestroy( $this->image );
312 $this->image = $rotated;
313 $this->update_size();
317 return new WP_Error( 'image_rotate_error', __('Image rotate failed.'), $this->file );
321 * Flips current image.
326 * @param boolean $horz Flip along Horizontal Axis
327 * @param boolean $vert Flip along Vertical Axis
328 * @returns boolean|WP_Error
330 public function flip( $horz, $vert ) {
331 $w = $this->size['width'];
332 $h = $this->size['height'];
333 $dst = wp_imagecreatetruecolor( $w, $h );
335 if ( is_resource( $dst ) ) {
336 $sx = $vert ? ($w - 1) : 0;
337 $sy = $horz ? ($h - 1) : 0;
338 $sw = $vert ? -$w : $w;
339 $sh = $horz ? -$h : $h;
341 if ( imagecopyresampled( $dst, $this->image, 0, 0, $sx, $sy, $w, $h, $sw, $sh ) ) {
342 imagedestroy( $this->image );
347 return new WP_Error( 'image_flip_error', __('Image flip failed.'), $this->file );
351 * Saves current in-memory image to file.
356 * @param string $destfilename
357 * @param string $mime_type
358 * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
360 public function save( $filename = null, $mime_type = null ) {
361 $saved = $this->_save( $this->image, $filename, $mime_type );
363 if ( ! is_wp_error( $saved ) ) {
364 $this->file = $saved['path'];
365 $this->mime_type = $saved['mime-type'];
371 protected function _save( $image, $filename = null, $mime_type = null ) {
372 list( $filename, $extension, $mime_type ) = $this->get_output_format( $filename, $mime_type );
375 $filename = $this->generate_filename( null, null, $extension );
377 if ( 'image/gif' == $mime_type ) {
378 if ( ! $this->make_image( $filename, 'imagegif', array( $image, $filename ) ) )
379 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
381 elseif ( 'image/png' == $mime_type ) {
382 // convert from full colors to index colors, like original PNG.
383 if ( function_exists('imageistruecolor') && ! imageistruecolor( $image ) )
384 imagetruecolortopalette( $image, false, imagecolorstotal( $image ) );
386 if ( ! $this->make_image( $filename, 'imagepng', array( $image, $filename ) ) )
387 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
389 elseif ( 'image/jpeg' == $mime_type ) {
390 if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, $this->get_quality() ) ) )
391 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
394 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
397 // Set correct file permissions
398 $stat = stat( dirname( $filename ) );
399 $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits
400 @ chmod( $filename, $perms );
403 * Filter the name of the saved image file.
407 * @param string $filename Name of the file.
411 'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
412 'width' => $this->size['width'],
413 'height' => $this->size['height'],
414 'mime-type' => $mime_type,
419 * Returns stream of current image.
424 * @param string $mime_type
426 public function stream( $mime_type = null ) {
427 list( $filename, $extension, $mime_type ) = $this->get_output_format( null, $mime_type );
429 switch ( $mime_type ) {
431 header( 'Content-Type: image/png' );
432 return imagepng( $this->image );
434 header( 'Content-Type: image/gif' );
435 return imagegif( $this->image );
437 header( 'Content-Type: image/jpeg' );
438 return imagejpeg( $this->image, null, $this->get_quality() );
443 * Either calls editor's save function or handles file as a stream.
448 * @param string|stream $filename
449 * @param callable $function
450 * @param array $arguments
453 protected function make_image( $filename, $function, $arguments ) {
454 if ( wp_is_stream( $filename ) )
455 $arguments[1] = null;
457 return parent::make_image( $filename, $function, $arguments );