3 * Base WordPress Image Editor
6 * @subpackage Image_Editor
10 * Base image editor class from which implementations extend
14 abstract class WP_Image_Editor {
15 protected $file = null;
16 protected $size = null;
17 protected $mime_type = null;
18 protected $default_mime_type = 'image/jpeg';
19 protected $quality = 90;
22 * Each instance handles a single file.
24 public function __construct( $file ) {
29 * Checks to see if current environment supports the editor chosen.
30 * Must be overridden in a sub-class.
39 public static function test( $args = array() ) {
44 * Checks to see if editor supports the mime-type specified.
45 * Must be overridden in a sub-class.
51 * @param string $mime_type
54 public static function supports_mime_type( $mime_type ) {
59 * Loads image from $this->file into editor.
65 * @return boolean|WP_Error True if loaded; WP_Error on failure.
67 abstract public function load();
70 * Saves current image to file.
76 * @param string $destfilename
77 * @param string $mime_type
78 * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
80 abstract public function save( $destfilename = null, $mime_type = null );
83 * Resizes current image.
85 * At minimum, either a height or width must be provided.
86 * If one of the two is set to null, the resize will
87 * maintain aspect ratio according to the provided dimension.
93 * @param int|null $max_w Image width.
94 * @param int|null $max_h Image height.
95 * @param boolean $crop
96 * @return boolean|WP_Error
98 abstract public function resize( $max_w, $max_h, $crop = false );
101 * Resize multiple images from a single source.
107 * @param array $sizes {
108 * An array of image size arrays. Default sizes are 'small', 'medium', 'large'.
110 * @type array $size {
111 * @type int $width Image width.
112 * @type int $height Image height.
113 * @type bool $crop Optional. Whether to crop the image. Default false.
116 * @return array An array of resized images metadata by size.
118 abstract public function multi_resize( $sizes );
127 * @param string|int $src The source file or Attachment ID.
128 * @param int $src_x The start x position to crop from.
129 * @param int $src_y The start y position to crop from.
130 * @param int $src_w The width to crop.
131 * @param int $src_h The height to crop.
132 * @param int $dst_w Optional. The destination width.
133 * @param int $dst_h Optional. The destination height.
134 * @param boolean $src_abs Optional. If the source crop points are absolute.
135 * @return boolean|WP_Error
137 abstract public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false );
140 * Rotates current image counter-clockwise by $angle.
146 * @param float $angle
147 * @return boolean|WP_Error
149 abstract public function rotate( $angle );
152 * Flips current image.
158 * @param boolean $horz Flip along Horizontal Axis
159 * @param boolean $vert Flip along Vertical Axis
160 * @return boolean|WP_Error
162 abstract public function flip( $horz, $vert );
165 * Streams current image to browser.
171 * @param string $mime_type
172 * @return boolean|WP_Error
174 abstract public function stream( $mime_type = null );
177 * Gets dimensions of image.
182 * @return array {'width'=>int, 'height'=>int}
184 public function get_size() {
189 * Sets current image size.
197 protected function update_size( $width = null, $height = null ) {
199 'width' => (int) $width,
200 'height' => (int) $height
206 * Sets Image Compression quality on a 1-100% scale.
211 * @param int $quality Compression Quality. Range: [1,100]
212 * @return boolean|WP_Error True if set successfully; WP_Error on failure.
214 public function set_quality( $quality = null ) {
215 if ( $quality == null ) {
216 $quality = $this->quality;
220 * Filter the default image compression quality setting.
224 * @param int $quality Quality level between 1 (low) and 100 (high).
225 * @param string $mime_type Image mime type.
227 $quality = apply_filters( 'wp_editor_set_quality', $quality, $this->mime_type );
229 if ( 'image/jpeg' == $this->mime_type ) {
231 * Filter the JPEG compression quality for backward-compatibility.
233 * The filter is evaluated under two contexts: 'image_resize', and 'edit_image',
234 * (when a JPEG image is saved to file).
238 * @param int $quality Quality level between 0 (low) and 100 (high) of the JPEG.
239 * @param string $context Context of the filter.
241 $quality = apply_filters( 'jpeg_quality', $quality, 'image_resize' );
243 // Allow 0, but squash to 1 due to identical images in GD, and for backwards compatibility.
244 if ( $quality == 0 ) {
249 if ( ( $quality >= 1 ) && ( $quality <= 100 ) ){
250 $this->quality = $quality;
253 return new WP_Error( 'invalid_image_quality', __('Attempted to set image quality outside of the range [1,100].') );
258 * Returns preferred mime-type and extension based on provided
259 * file's extension and mime, or current file's extension and mime.
261 * Will default to $this->default_mime_type if requested is not supported.
263 * Provides corrected filename only if filename is provided.
268 * @param string $filename
269 * @param string $mime_type
270 * @return array { filename|null, extension, mime-type }
272 protected function get_output_format( $filename = null, $mime_type = null ) {
273 $new_ext = $file_ext = null;
276 // By default, assume specified type takes priority
278 $new_ext = $this->get_extension( $mime_type );
282 $file_ext = strtolower( pathinfo( $filename, PATHINFO_EXTENSION ) );
283 $file_mime = $this->get_mime_type( $file_ext );
286 // If no file specified, grab editor's current extension and mime-type.
287 $file_ext = strtolower( pathinfo( $this->file, PATHINFO_EXTENSION ) );
288 $file_mime = $this->mime_type;
291 // Check to see if specified mime-type is the same as type implied by
292 // file extension. If so, prefer extension from file.
293 if ( ! $mime_type || ( $file_mime == $mime_type ) ) {
294 $mime_type = $file_mime;
295 $new_ext = $file_ext;
298 // Double-check that the mime-type selected is supported by the editor.
299 // If not, choose a default instead.
300 if ( ! $this->supports_mime_type( $mime_type ) ) {
302 * Filter default mime type prior to getting the file extension.
304 * @see wp_get_mime_types()
308 * @param string $mime_type Mime type string.
310 $mime_type = apply_filters( 'image_editor_default_mime_type', $this->default_mime_type );
311 $new_ext = $this->get_extension( $mime_type );
316 $info = pathinfo( $filename );
317 $dir = $info['dirname'];
319 if( isset( $info['extension'] ) )
320 $ext = $info['extension'];
322 $filename = trailingslashit( $dir ) . wp_basename( $filename, ".$ext" ) . ".{$new_ext}";
325 return array( $filename, $new_ext, $mime_type );
329 * Builds an output filename based on current file, and adding proper suffix
334 * @param string $suffix
335 * @param string $dest_path
336 * @param string $extension
337 * @return string filename
339 public function generate_filename( $suffix = null, $dest_path = null, $extension = null ) {
340 // $suffix will be appended to the destination filename, just before the extension
342 $suffix = $this->get_suffix();
344 $info = pathinfo( $this->file );
345 $dir = $info['dirname'];
346 $ext = $info['extension'];
348 $name = wp_basename( $this->file, ".$ext" );
349 $new_ext = strtolower( $extension ? $extension : $ext );
351 if ( ! is_null( $dest_path ) && $_dest_path = realpath( $dest_path ) )
354 return trailingslashit( $dir ) . "{$name}-{$suffix}.{$new_ext}";
358 * Builds and returns proper suffix for file based on height and width.
363 * @return string suffix
365 public function get_suffix() {
366 if ( ! $this->get_size() )
369 return "{$this->size['width']}x{$this->size['height']}";
373 * Either calls editor's save function or handles file as a stream.
378 * @param string|stream $filename
379 * @param callable $function
380 * @param array $arguments
383 protected function make_image( $filename, $function, $arguments ) {
384 if ( $stream = wp_is_stream( $filename ) ) {
387 // The directory containing the original file may no longer exist when using a replication plugin.
388 wp_mkdir_p( dirname( $filename ) );
391 $result = call_user_func_array( $function, $arguments );
393 if ( $result && $stream ) {
394 $contents = ob_get_contents();
396 $fp = fopen( $filename, 'w' );
401 fwrite( $fp, $contents );
413 * Returns first matched mime-type from extension,
414 * as mapped from wp_get_mime_types()
419 * @param string $extension
420 * @return string|boolean
422 protected static function get_mime_type( $extension = null ) {
426 $mime_types = wp_get_mime_types();
427 $extensions = array_keys( $mime_types );
429 foreach( $extensions as $_extension ) {
430 if ( preg_match( "/{$extension}/i", $_extension ) ) {
431 return $mime_types[$_extension];
439 * Returns first matched extension from Mime-type,
440 * as mapped from wp_get_mime_types()
445 * @param string $mime_type
446 * @return string|boolean
448 protected static function get_extension( $mime_type = null ) {
449 $extensions = explode( '|', array_search( $mime_type, wp_get_mime_types() ) );
451 if ( empty( $extensions[0] ) )
454 return $extensions[0];