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 = false;
20 protected $default_quality = 90;
23 * Each instance handles a single file.
25 public function __construct( $file ) {
30 * Checks to see if current environment supports the editor chosen.
31 * Must be overridden in a sub-class.
42 public static function test( $args = array() ) {
47 * Checks to see if editor supports the mime-type specified.
48 * Must be overridden in a sub-class.
56 * @param string $mime_type
59 public static function supports_mime_type( $mime_type ) {
64 * Loads image from $this->file into editor.
70 * @return bool|WP_Error True if loaded; WP_Error on failure.
72 abstract public function load();
75 * Saves current image to file.
81 * @param string $destfilename
82 * @param string $mime_type
83 * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string}
85 abstract public function save( $destfilename = null, $mime_type = null );
88 * Resizes current image.
90 * At minimum, either a height or width must be provided.
91 * If one of the two is set to null, the resize will
92 * maintain aspect ratio according to the provided dimension.
98 * @param int|null $max_w Image width.
99 * @param int|null $max_h Image height.
101 * @return bool|WP_Error
103 abstract public function resize( $max_w, $max_h, $crop = false );
106 * Resize multiple images from a single source.
112 * @param array $sizes {
113 * An array of image size arrays. Default sizes are 'small', 'medium', 'large'.
115 * @type array $size {
116 * @type int $width Image width.
117 * @type int $height Image height.
118 * @type bool $crop Optional. Whether to crop the image. Default false.
121 * @return array An array of resized images metadata by size.
123 abstract public function multi_resize( $sizes );
132 * @param int $src_x The start x position to crop from.
133 * @param int $src_y The start y position to crop from.
134 * @param int $src_w The width to crop.
135 * @param int $src_h The height to crop.
136 * @param int $dst_w Optional. The destination width.
137 * @param int $dst_h Optional. The destination height.
138 * @param bool $src_abs Optional. If the source crop points are absolute.
139 * @return bool|WP_Error
141 abstract public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false );
144 * Rotates current image counter-clockwise by $angle.
150 * @param float $angle
151 * @return bool|WP_Error
153 abstract public function rotate( $angle );
156 * Flips current image.
162 * @param bool $horz Flip along Horizontal Axis
163 * @param bool $vert Flip along Vertical Axis
164 * @return bool|WP_Error
166 abstract public function flip( $horz, $vert );
169 * Streams current image to browser.
175 * @param string $mime_type
176 * @return bool|WP_Error
178 abstract public function stream( $mime_type = null );
181 * Gets dimensions of image.
186 * @return array {'width'=>int, 'height'=>int}
188 public function get_size() {
193 * Sets current image size.
202 protected function update_size( $width = null, $height = null ) {
204 'width' => (int) $width,
205 'height' => (int) $height
211 * Gets the Image Compression quality on a 1-100% scale.
216 * @return int $quality Compression Quality. Range: [1,100]
218 public function get_quality() {
219 if ( ! $this->quality ) {
220 $this->set_quality();
223 return $this->quality;
227 * Sets Image Compression quality on a 1-100% scale.
232 * @param int $quality Compression Quality. Range: [1,100]
233 * @return true|WP_Error True if set successfully; WP_Error on failure.
235 public function set_quality( $quality = null ) {
236 if ( null === $quality ) {
238 * Filter the default image compression quality setting.
240 * Applies only during initial editor instantiation, or when set_quality() is run
241 * manually without the `$quality` argument.
243 * set_quality() has priority over the filter.
247 * @param int $quality Quality level between 1 (low) and 100 (high).
248 * @param string $mime_type Image mime type.
250 $quality = apply_filters( 'wp_editor_set_quality', $this->default_quality, $this->mime_type );
252 if ( 'image/jpeg' == $this->mime_type ) {
254 * Filter the JPEG compression quality for backward-compatibility.
256 * Applies only during initial editor instantiation, or when set_quality() is run
257 * manually without the `$quality` argument.
259 * set_quality() has priority over the filter.
261 * The filter is evaluated under two contexts: 'image_resize', and 'edit_image',
262 * (when a JPEG image is saved to file).
266 * @param int $quality Quality level between 0 (low) and 100 (high) of the JPEG.
267 * @param string $context Context of the filter.
269 $quality = apply_filters( 'jpeg_quality', $quality, 'image_resize' );
272 if ( $quality < 0 || $quality > 100 ) {
273 $quality = $this->default_quality;
277 // Allow 0, but squash to 1 due to identical images in GD, and for backwards compatibility.
278 if ( 0 === $quality ) {
282 if ( ( $quality >= 1 ) && ( $quality <= 100 ) ) {
283 $this->quality = $quality;
286 return new WP_Error( 'invalid_image_quality', __('Attempted to set image quality outside of the range [1,100].') );
291 * Returns preferred mime-type and extension based on provided
292 * file's extension and mime, or current file's extension and mime.
294 * Will default to $this->default_mime_type if requested is not supported.
296 * Provides corrected filename only if filename is provided.
301 * @param string $filename
302 * @param string $mime_type
303 * @return array { filename|null, extension, mime-type }
305 protected function get_output_format( $filename = null, $mime_type = null ) {
308 // By default, assume specified type takes priority
310 $new_ext = $this->get_extension( $mime_type );
314 $file_ext = strtolower( pathinfo( $filename, PATHINFO_EXTENSION ) );
315 $file_mime = $this->get_mime_type( $file_ext );
318 // If no file specified, grab editor's current extension and mime-type.
319 $file_ext = strtolower( pathinfo( $this->file, PATHINFO_EXTENSION ) );
320 $file_mime = $this->mime_type;
323 // Check to see if specified mime-type is the same as type implied by
324 // file extension. If so, prefer extension from file.
325 if ( ! $mime_type || ( $file_mime == $mime_type ) ) {
326 $mime_type = $file_mime;
327 $new_ext = $file_ext;
330 // Double-check that the mime-type selected is supported by the editor.
331 // If not, choose a default instead.
332 if ( ! $this->supports_mime_type( $mime_type ) ) {
334 * Filter default mime type prior to getting the file extension.
336 * @see wp_get_mime_types()
340 * @param string $mime_type Mime type string.
342 $mime_type = apply_filters( 'image_editor_default_mime_type', $this->default_mime_type );
343 $new_ext = $this->get_extension( $mime_type );
348 $info = pathinfo( $filename );
349 $dir = $info['dirname'];
351 if ( isset( $info['extension'] ) )
352 $ext = $info['extension'];
354 $filename = trailingslashit( $dir ) . wp_basename( $filename, ".$ext" ) . ".{$new_ext}";
357 return array( $filename, $new_ext, $mime_type );
361 * Builds an output filename based on current file, and adding proper suffix
366 * @param string $suffix
367 * @param string $dest_path
368 * @param string $extension
369 * @return string filename
371 public function generate_filename( $suffix = null, $dest_path = null, $extension = null ) {
372 // $suffix will be appended to the destination filename, just before the extension
374 $suffix = $this->get_suffix();
376 $info = pathinfo( $this->file );
377 $dir = $info['dirname'];
378 $ext = $info['extension'];
380 $name = wp_basename( $this->file, ".$ext" );
381 $new_ext = strtolower( $extension ? $extension : $ext );
383 if ( ! is_null( $dest_path ) && $_dest_path = realpath( $dest_path ) )
386 return trailingslashit( $dir ) . "{$name}-{$suffix}.{$new_ext}";
390 * Builds and returns proper suffix for file based on height and width.
395 * @return false|string suffix
397 public function get_suffix() {
398 if ( ! $this->get_size() )
401 return "{$this->size['width']}x{$this->size['height']}";
405 * Either calls editor's save function or handles file as a stream.
410 * @param string|stream $filename
411 * @param callable $function
412 * @param array $arguments
415 protected function make_image( $filename, $function, $arguments ) {
416 if ( $stream = wp_is_stream( $filename ) ) {
419 // The directory containing the original file may no longer exist when using a replication plugin.
420 wp_mkdir_p( dirname( $filename ) );
423 $result = call_user_func_array( $function, $arguments );
425 if ( $result && $stream ) {
426 $contents = ob_get_contents();
428 $fp = fopen( $filename, 'w' );
433 fwrite( $fp, $contents );
445 * Returns first matched mime-type from extension,
446 * as mapped from wp_get_mime_types()
453 * @param string $extension
454 * @return string|false
456 protected static function get_mime_type( $extension = null ) {
460 $mime_types = wp_get_mime_types();
461 $extensions = array_keys( $mime_types );
463 foreach ( $extensions as $_extension ) {
464 if ( preg_match( "/{$extension}/i", $_extension ) ) {
465 return $mime_types[$_extension];
473 * Returns first matched extension from Mime-type,
474 * as mapped from wp_get_mime_types()
481 * @param string $mime_type
482 * @return string|false
484 protected static function get_extension( $mime_type = null ) {
485 $extensions = explode( '|', array_search( $mime_type, wp_get_mime_types() ) );
487 if ( empty( $extensions[0] ) )
490 return $extensions[0];