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 {
21 protected $image; // GD Resource
23 public function __destruct() {
25 // we don't need the original in memory anymore
26 imagedestroy( $this->image );
31 * Checks to see if current environment supports GD.
38 public static function test( $args = array() ) {
39 if ( ! extension_loaded('gd') || ! function_exists('gd_info') )
42 // On some setups GD library does not provide imagerotate() - Ticket #11536
43 if ( isset( $args['methods'] ) &&
44 in_array( 'rotate', $args['methods'] ) &&
45 ! function_exists('imagerotate') ){
54 * Checks to see if editor supports the mime-type specified.
59 * @param string $mime_type
62 public static function supports_mime_type( $mime_type ) {
63 $image_types = imagetypes();
64 switch( $mime_type ) {
66 return ($image_types & IMG_JPG) != 0;
68 return ($image_types & IMG_PNG) != 0;
70 return ($image_types & IMG_GIF) != 0;
77 * Loads image from $this->file into new GD Resource.
82 * @return boolean|WP_Error True if loaded successfully; WP_Error on failure.
84 public function load() {
88 if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
89 return new WP_Error( 'error_loading_image', __('File doesn’t exist?'), $this->file );
92 * Filter the memory limit allocated for image manipulation.
96 * @param int|string $limit Maximum memory limit to allocate for images. Default WP_MAX_MEMORY_LIMIT.
97 * Accepts an integer (bytes), or a shorthand string notation, such as '256M'.
99 // Set artificially high because GD uses uncompressed images in memory
100 @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
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.
131 protected function update_size( $width = false, $height = false ) {
133 $width = imagesx( $this->image );
136 $height = imagesy( $this->image );
138 return parent::update_size( $width, $height );
142 * Resizes current image.
143 * Wraps _resize, since _resize returns a GD Resource.
145 * At minimum, either a height or width must be provided.
146 * If one of the two is set to null, the resize will
147 * maintain aspect ratio according to the provided dimension.
152 * @param int|null $max_w Image width.
153 * @param int|null $max_h Image height.
154 * @param boolean $crop
155 * @return boolean|WP_Error
157 public function resize( $max_w, $max_h, $crop = false ) {
158 if ( ( $this->size['width'] == $max_w ) && ( $this->size['height'] == $max_h ) )
161 $resized = $this->_resize( $max_w, $max_h, $crop );
163 if ( is_resource( $resized ) ) {
164 imagedestroy( $this->image );
165 $this->image = $resized;
168 } elseif ( is_wp_error( $resized ) )
171 return new WP_Error( 'image_resize_error', __('Image resize failed.'), $this->file );
174 protected function _resize( $max_w, $max_h, $crop = false ) {
175 $dims = image_resize_dimensions( $this->size['width'], $this->size['height'], $max_w, $max_h, $crop );
177 return new WP_Error( 'error_getting_dimensions', __('Could not calculate resized image dimensions'), $this->file );
179 list( $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h ) = $dims;
181 $resized = wp_imagecreatetruecolor( $dst_w, $dst_h );
182 imagecopyresampled( $resized, $this->image, $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
184 if ( is_resource( $resized ) ) {
185 $this->update_size( $dst_w, $dst_h );
189 return new WP_Error( 'image_resize_error', __('Image resize failed.'), $this->file );
193 * Resize multiple images from a single source.
198 * @param array $sizes {
199 * An array of image size arrays. Default sizes are 'small', 'medium', 'large'.
201 * Either a height or width must be provided.
202 * If one of the two is set to null, the resize will
203 * maintain aspect ratio according to the provided dimension.
205 * @type array $size {
206 * @type int ['width'] Optional. Image width.
207 * @type int ['height'] Optional. Image height.
208 * @type bool ['crop'] Optional. Whether to crop the image. Default false.
211 * @return array An array of resized images' metadata by size.
213 public function multi_resize( $sizes ) {
215 $orig_size = $this->size;
217 foreach ( $sizes as $size => $size_data ) {
218 if ( ! isset( $size_data['width'] ) && ! isset( $size_data['height'] ) ) {
222 if ( ! isset( $size_data['width'] ) ) {
223 $size_data['width'] = null;
225 if ( ! isset( $size_data['height'] ) ) {
226 $size_data['height'] = null;
229 if ( ! isset( $size_data['crop'] ) ) {
230 $size_data['crop'] = false;
233 $image = $this->_resize( $size_data['width'], $size_data['height'], $size_data['crop'] );
234 $duplicate = ( ( $orig_size['width'] == $size_data['width'] ) && ( $orig_size['height'] == $size_data['height'] ) );
236 if ( ! is_wp_error( $image ) && ! $duplicate ) {
237 $resized = $this->_save( $image );
239 imagedestroy( $image );
241 if ( ! is_wp_error( $resized ) && $resized ) {
242 unset( $resized['path'] );
243 $metadata[$size] = $resized;
247 $this->size = $orig_size;
259 * @param int $src_x The start x position to crop from.
260 * @param int $src_y The start y position to crop from.
261 * @param int $src_w The width to crop.
262 * @param int $src_h The height to crop.
263 * @param int $dst_w Optional. The destination width.
264 * @param int $dst_h Optional. The destination height.
265 * @param boolean $src_abs Optional. If the source crop points are absolute.
266 * @return boolean|WP_Error
268 public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false ) {
269 // If destination width/height isn't specified, use same as
270 // width/height from source.
276 $dst = wp_imagecreatetruecolor( $dst_w, $dst_h );
283 if ( function_exists( 'imageantialias' ) )
284 imageantialias( $dst, true );
286 imagecopyresampled( $dst, $this->image, 0, 0, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h );
288 if ( is_resource( $dst ) ) {
289 imagedestroy( $this->image );
291 $this->update_size();
295 return new WP_Error( 'image_crop_error', __('Image crop failed.'), $this->file );
299 * Rotates current image counter-clockwise by $angle.
300 * Ported from image-edit.php
305 * @param float $angle
306 * @return boolean|WP_Error
308 public function rotate( $angle ) {
309 if ( function_exists('imagerotate') ) {
310 $transparency = imagecolorallocatealpha( $this->image, 255, 255, 255, 127 );
311 $rotated = imagerotate( $this->image, $angle, $transparency );
313 if ( is_resource( $rotated ) ) {
314 imagealphablending( $rotated, true );
315 imagesavealpha( $rotated, true );
316 imagedestroy( $this->image );
317 $this->image = $rotated;
318 $this->update_size();
322 return new WP_Error( 'image_rotate_error', __('Image rotate failed.'), $this->file );
326 * Flips current image.
331 * @param boolean $horz Flip along Horizontal Axis
332 * @param boolean $vert Flip along Vertical Axis
333 * @returns boolean|WP_Error
335 public function flip( $horz, $vert ) {
336 $w = $this->size['width'];
337 $h = $this->size['height'];
338 $dst = wp_imagecreatetruecolor( $w, $h );
340 if ( is_resource( $dst ) ) {
341 $sx = $vert ? ($w - 1) : 0;
342 $sy = $horz ? ($h - 1) : 0;
343 $sw = $vert ? -$w : $w;
344 $sh = $horz ? -$h : $h;
346 if ( imagecopyresampled( $dst, $this->image, 0, 0, $sx, $sy, $w, $h, $sw, $sh ) ) {
347 imagedestroy( $this->image );
352 return new WP_Error( 'image_flip_error', __('Image flip failed.'), $this->file );
356 * Saves current in-memory image to file.
361 * @param string|null $filename
362 * @param string|null $mime_type
363 * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
365 public function save( $filename = null, $mime_type = null ) {
366 $saved = $this->_save( $this->image, $filename, $mime_type );
368 if ( ! is_wp_error( $saved ) ) {
369 $this->file = $saved['path'];
370 $this->mime_type = $saved['mime-type'];
377 * @param resource $image
378 * @param string|null $filename
379 * @param string|null $mime_type
380 * @return WP_Error|array
382 protected function _save( $image, $filename = null, $mime_type = null ) {
383 list( $filename, $extension, $mime_type ) = $this->get_output_format( $filename, $mime_type );
386 $filename = $this->generate_filename( null, null, $extension );
388 if ( 'image/gif' == $mime_type ) {
389 if ( ! $this->make_image( $filename, 'imagegif', array( $image, $filename ) ) )
390 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
392 elseif ( 'image/png' == $mime_type ) {
393 // convert from full colors to index colors, like original PNG.
394 if ( function_exists('imageistruecolor') && ! imageistruecolor( $image ) )
395 imagetruecolortopalette( $image, false, imagecolorstotal( $image ) );
397 if ( ! $this->make_image( $filename, 'imagepng', array( $image, $filename ) ) )
398 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
400 elseif ( 'image/jpeg' == $mime_type ) {
401 if ( ! $this->make_image( $filename, 'imagejpeg', array( $image, $filename, $this->get_quality() ) ) )
402 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
405 return new WP_Error( 'image_save_error', __('Image Editor Save Failed') );
408 // Set correct file permissions
409 $stat = stat( dirname( $filename ) );
410 $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits
411 @ chmod( $filename, $perms );
414 * Filter the name of the saved image file.
418 * @param string $filename Name of the file.
422 'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
423 'width' => $this->size['width'],
424 'height' => $this->size['height'],
425 'mime-type' => $mime_type,
430 * Returns stream of current image.
435 * @param string $mime_type
437 public function stream( $mime_type = null ) {
438 list( $filename, $extension, $mime_type ) = $this->get_output_format( null, $mime_type );
440 switch ( $mime_type ) {
442 header( 'Content-Type: image/png' );
443 return imagepng( $this->image );
445 header( 'Content-Type: image/gif' );
446 return imagegif( $this->image );
448 header( 'Content-Type: image/jpeg' );
449 return imagejpeg( $this->image, null, $this->get_quality() );
454 * Either calls editor's save function or handles file as a stream.
459 * @param string|stream $filename
460 * @param callable $function
461 * @param array $arguments
464 protected function make_image( $filename, $function, $arguments ) {
465 if ( wp_is_stream( $filename ) )
466 $arguments[1] = null;
468 return parent::make_image( $filename, $function, $arguments );