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 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'];
117 return $this->set_quality( $this->quality );
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.
148 * @param boolean $crop
149 * @return boolean|WP_Error
151 public function resize( $max_w, $max_h, $crop = false ) {
152 if ( ( $this->size['width'] == $max_w ) && ( $this->size['height'] == $max_h ) )
155 $resized = $this->_resize( $max_w, $max_h, $crop );
157 if ( is_resource( $resized ) ) {
158 imagedestroy( $this->image );
159 $this->image = $resized;
162 } elseif ( is_wp_error( $resized ) )
165 return new WP_Error( 'image_resize_error', __('Image resize failed.'), $this->file );
168 protected function _resize( $max_w, $max_h, $crop = false ) {
169 $dims = image_resize_dimensions( $this->size['width'], $this->size['height'], $max_w, $max_h, $crop );
171 return new WP_Error( 'error_getting_dimensions', __('Could not calculate resized image dimensions'), $this->file );
173 list( $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h ) = $dims;
175 $resized = wp_imagecreatetruecolor( $dst_w, $dst_h );
176 imagecopyresampled( $resized, $this->image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
178 if ( is_resource( $resized ) ) {
179 $this->update_size( $dst_w, $dst_h );
183 return new WP_Error( 'image_resize_error', __('Image resize failed.'), $this->file );
187 * Resize multiple images from a single source.
192 * @param array $sizes {
193 * An array of image size arrays. Default sizes are 'small', 'medium', 'large'.
195 * @type array $size {
196 * @type int $width Image width.
197 * @type int $height Image height.
198 * @type bool $crop Optional. Whether to crop the image. Default false.
201 * @return array An array of resized images metadata by size.
203 public function multi_resize( $sizes ) {
205 $orig_size = $this->size;
207 foreach ( $sizes as $size => $size_data ) {
208 if ( ! ( isset( $size_data['width'] ) && isset( $size_data['height'] ) ) )
211 if ( ! isset( $size_data['crop'] ) )
212 $size_data['crop'] = false;
214 $image = $this->_resize( $size_data['width'], $size_data['height'], $size_data['crop'] );
216 if( ! is_wp_error( $image ) ) {
217 $resized = $this->_save( $image );
219 imagedestroy( $image );
221 if ( ! is_wp_error( $resized ) && $resized ) {
222 unset( $resized['path'] );
223 $metadata[$size] = $resized;
227 $this->size = $orig_size;
239 * @param string|int $src The source file or Attachment ID.
240 * @param int $src_x The start x position to crop from.
241 * @param int $src_y The start y position to crop from.
242 * @param int $src_w The width to crop.
243 * @param int $src_h The height to crop.
244 * @param int $dst_w Optional. The destination width.
245 * @param int $dst_h Optional. The destination height.
246 * @param boolean $src_abs Optional. If the source crop points are absolute.
247 * @return boolean|WP_Error
249 public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false ) {
250 // If destination width/height isn't specified, use same as
251 // width/height from source.
257 $dst = wp_imagecreatetruecolor( $dst_w, $dst_h );
264 if ( function_exists( 'imageantialias' ) )
265 imageantialias( $dst, true );
267 imagecopyresampled( $dst, $this->image, 0, 0, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
269 if ( is_resource( $dst ) ) {
270 imagedestroy( $this->image );
272 $this->update_size();
276 return new WP_Error( 'image_crop_error', __('Image crop failed.'), $this->file );
280 * Rotates current image counter-clockwise by $angle.
281 * Ported from image-edit.php
286 * @param float $angle
287 * @return boolean|WP_Error
289 public function rotate( $angle ) {
290 if ( function_exists('imagerotate') ) {
291 $rotated = imagerotate( $this->image, $angle, 0 );
293 if ( is_resource( $rotated ) ) {
294 imagedestroy( $this->image );
295 $this->image = $rotated;
296 $this->update_size();
300 return new WP_Error( 'image_rotate_error', __('Image rotate failed.'), $this->file );
304 * Flips current image.
309 * @param boolean $horz Flip along Horizontal Axis
310 * @param boolean $vert Flip along Vertical Axis
311 * @returns boolean|WP_Error
313 public function flip( $horz, $vert ) {
314 $w = $this->size['width'];
315 $h = $this->size['height'];
316 $dst = wp_imagecreatetruecolor( $w, $h );
318 if ( is_resource( $dst ) ) {
319 $sx = $vert ? ($w - 1) : 0;
320 $sy = $horz ? ($h - 1) : 0;
321 $sw = $vert ? -$w : $w;
322 $sh = $horz ? -$h : $h;
324 if ( imagecopyresampled( $dst, $this->image, 0, 0, $sx, $sy, $w, $h, $sw, $sh ) ) {
325 imagedestroy( $this->image );
330 return new WP_Error( 'image_flip_error', __('Image flip failed.'), $this->file );
334 * Saves current in-memory image to file.
339 * @param string $destfilename
340 * @param string $mime_type
341 * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
343 public function save( $filename = null, $mime_type = null ) {
344 $saved = $this->_save( $this->image, $filename, $mime_type );
346 if ( ! is_wp_error( $saved ) ) {
347 $this->file = $saved['path'];
348 $this->mime_type = $saved['mime-type'];
354 protected function _save( $image, $filename = null, $mime_type = null ) {
355 list( $filename, $extension, $mime_type ) = $this->get_output_format( $filename, $mime_type );
358 $filename = $this->generate_filename( null, null, $extension );
360 if ( 'image/gif' == $mime_type ) {
361 if ( ! $this->make_image( $filename, 'imagegif', array( $image, $filename ) ) )
362 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
364 elseif ( 'image/png' == $mime_type ) {
365 // convert from full colors to index colors, like original PNG.
366 if ( function_exists('imageistruecolor') && ! imageistruecolor( $image ) )
367 imagetruecolortopalette( $image, false, imagecolorstotal( $image ) );
369 if ( ! $this->make_image( $filename, 'imagepng', array( $image, $filename ) ) )
370 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
372 elseif ( 'image/jpeg' == $mime_type ) {
373 if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, $this->quality ) ) )
374 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
377 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
380 // Set correct file permissions
381 $stat = stat( dirname( $filename ) );
382 $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits
383 @ chmod( $filename, $perms );
386 * Filter the name of the saved image file.
390 * @param string $filename Name of the file.
394 'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
395 'width' => $this->size['width'],
396 'height' => $this->size['height'],
397 'mime-type' => $mime_type,
402 * Returns stream of current image.
407 * @param string $mime_type
409 public function stream( $mime_type = null ) {
410 list( $filename, $extension, $mime_type ) = $this->get_output_format( null, $mime_type );
412 switch ( $mime_type ) {
414 header( 'Content-Type: image/png' );
415 return imagepng( $this->image );
417 header( 'Content-Type: image/gif' );
418 return imagegif( $this->image );
420 header( 'Content-Type: image/jpeg' );
421 return imagejpeg( $this->image, null, $this->quality );
426 * Either calls editor's save function or handles file as a stream.
431 * @param string|stream $filename
432 * @param callable $function
433 * @param array $arguments
436 protected function make_image( $filename, $function, $arguments ) {
437 if ( wp_is_stream( $filename ) )
438 $arguments[1] = null;
440 return parent::make_image( $filename, $function, $arguments );