WP_Image_Editor
Base image editor class from which implementations extend
More Information
WP_Image_Editor is an abstract class, so it can’t be called directly. It is used for implementations like WP_Image_Editor_GD and WP_Image_Editor_Imagick. It has some base functionality that can be used by those implementations.
Methods
You shouldn’t call an implementation directly. Instead, use wp_get_image_editor(), which looks at which implementation is the best.
(An ampersand (&) before a method name indicates it returns by reference.)
Note: Refer below Methods section for complete list and link to the method.
- supports_mime_type( $mime_type )
- Checks to see if editor supports the mime-type specified.
- save( $destfilename = null, $mime_type = null )
- Saves current image to file.
- resize( $max_w, $max_h, $crop = false )
- Resizes current image.
- Crop value:
1. If false (default), images will not be cropped. 2. If an array in the form of array( x_crop_position, y_crop_position ): - x_crop_position accepts 'left' 'center', or 'right'. - y_crop_position accepts 'top', 'center', or 'bottom'.
- Images will be cropped to the specified dimensions within the defined crop area.
3. If true, images will be cropped to the specified dimensions using center positions.
- multi_resize( $sizes );
- Processes current image and saves to disk multiple sizes from single source.
- crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false )
- Crops Image.
- rotate( $angle )
- Rotates current image counter-clockwise by $angle.
- flip( $horz, $vert )
- Flips current image on the horizontal or vertical axis.
- stream( $mime_type = null )
- Streams current image to browser.
- get_size()
- Gets dimensions of image as an array with keys ‘width’ and ‘height’.
- update_size( $width = null, $height = null )
- Sets current image size.
- set_quality( $quality )
- Sets Image Compression quality on a 1-100% scale as an integer (1-100). Default quality defined in WP_Image_Editor class is 90.
- get_output_format( $filename = null, $mime_type = null )
- Returns preferred mime-type and extension based on provided file’s extension and mime, or current file’s extension and mime. Will default to `$this->default_mime_type` if requested is not supported. Provides corrected filename only if filename is provided.
- generate_filename( $suffix = null, $dest_path = null, $extension = null )
- Builds an output filename based on current file, and adding proper suffix.
- get_suffix()
- Builds and returns proper suffix for file based on height and width.
- make_image( $filename, $function, $arguments )
- Either calls editor’s save function or handles file as a stream.
- get_mime_type( $extension = null )
- Returns first matched mime-type from extension, as mapped from wp_get_mime_types().
- get_extension( $mime_type = null )
- Returns first matched extension from Mime-type, as mapped from wp_get_mime_types().
Source
File: wp-includes/class-wp-image-editor.php
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 |
abstract class WP_Image_Editor { protected $file = null; protected $size = null; protected $mime_type = null; protected $default_mime_type = 'image/jpeg' ; protected $quality = false; protected $default_quality = 82; /** * Each instance handles a single file. * * @param string $file Path to the file to load. */ public function __construct( $file ) { $this ->file = $file ; } /** * Checks to see if current environment supports the editor chosen. * Must be overridden in a subclass. * * @since 3.5.0 * * @abstract * * @param array $args * @return bool */ public static function test( $args = array () ) { return false; } /** * Checks to see if editor supports the mime-type specified. * Must be overridden in a subclass. * * @since 3.5.0 * * @abstract * * @param string $mime_type * @return bool */ public static function supports_mime_type( $mime_type ) { return false; } /** * Loads image from $this->file into editor. * * @since 3.5.0 * @abstract * * @return bool|WP_Error True if loaded; WP_Error on failure. */ abstract public function load(); /** * Saves current image to file. * * @since 3.5.0 * @abstract * * @param string $destfilename * @param string $mime_type * @return array|WP_Error {'path'=>string, 'file'=>string, 'width'=>int, 'height'=>int, 'mime-type'=>string} */ abstract public function save( $destfilename = null, $mime_type = null ); /** * Resizes current image. * * At minimum, either a height or width must be provided. * If one of the two is set to null, the resize will * maintain aspect ratio according to the provided dimension. * * @since 3.5.0 * @abstract * * @param int|null $max_w Image width. * @param int|null $max_h Image height. * @param bool $crop * @return bool|WP_Error */ abstract public function resize( $max_w , $max_h , $crop = false ); /** * Resize multiple images from a single source. * * @since 3.5.0 * @abstract * * @param array $sizes { * An array of image size arrays. Default sizes are 'small', 'medium', 'large'. * * @type array $size { * @type int $width Image width. * @type int $height Image height. * @type bool $crop Optional. Whether to crop the image. Default false. * } * } * @return array An array of resized images metadata by size. */ abstract public function multi_resize( $sizes ); /** * Crops Image. * * @since 3.5.0 * @abstract * * @param int $src_x The start x position to crop from. * @param int $src_y The start y position to crop from. * @param int $src_w The width to crop. * @param int $src_h The height to crop. * @param int $dst_w Optional. The destination width. * @param int $dst_h Optional. The destination height. * @param bool $src_abs Optional. If the source crop points are absolute. * @return bool|WP_Error */ abstract public function crop( $src_x , $src_y , $src_w , $src_h , $dst_w = null, $dst_h = null, $src_abs = false ); /** * Rotates current image counter-clockwise by $angle. * * @since 3.5.0 * @abstract * * @param float $angle * @return bool|WP_Error */ abstract public function rotate( $angle ); /** * Flips current image. * * @since 3.5.0 * @abstract * * @param bool $horz Flip along Horizontal Axis * @param bool $vert Flip along Vertical Axis * @return bool|WP_Error */ abstract public function flip( $horz , $vert ); /** * Streams current image to browser. * * @since 3.5.0 * @abstract * * @param string $mime_type The mime type of the image. * @return bool|WP_Error True on success, WP_Error object or false on failure. */ abstract public function stream( $mime_type = null ); /** * Gets dimensions of image. * * @since 3.5.0 * * @return array { * Dimensions of the image. * * @type int $width The image width. * @type int $height The image height. * } */ public function get_size() { return $this ->size; } /** * Sets current image size. * * @since 3.5.0 * * @param int $width * @param int $height * @return true */ protected function update_size( $width = null, $height = null ) { $this ->size = array ( 'width' => (int) $width , 'height' => (int) $height , ); return true; } /** * Gets the Image Compression quality on a 1-100% scale. * * @since 4.0.0 * * @return int Compression Quality. Range: [1,100] */ public function get_quality() { if ( ! $this ->quality ) { $this ->set_quality(); } return $this ->quality; } /** * Sets Image Compression quality on a 1-100% scale. * * @since 3.5.0 * * @param int $quality Compression Quality. Range: [1,100] * @return true|WP_Error True if set successfully; WP_Error on failure. */ public function set_quality( $quality = null ) { if ( null === $quality ) { /** * Filters the default image compression quality setting. * * Applies only during initial editor instantiation, or when set_quality() is run * manually without the `$quality` argument. * * The WP_Image_Editor::set_quality() method has priority over the filter. * * @since 3.5.0 * * @param int $quality Quality level between 1 (low) and 100 (high). * @param string $mime_type Image mime type. */ $quality = apply_filters( 'wp_editor_set_quality' , $this ->default_quality, $this ->mime_type ); if ( 'image/jpeg' === $this ->mime_type ) { /** * Filters the JPEG compression quality for backward-compatibility. * * Applies only during initial editor instantiation, or when set_quality() is run * manually without the `$quality` argument. * * The WP_Image_Editor::set_quality() method has priority over the filter. * * The filter is evaluated under two contexts: 'image_resize', and 'edit_image', * (when a JPEG image is saved to file). * * @since 2.5.0 * * @param int $quality Quality level between 0 (low) and 100 (high) of the JPEG. * @param string $context Context of the filter. */ $quality = apply_filters( 'jpeg_quality' , $quality , 'image_resize' ); } if ( $quality < 0 || $quality > 100 ) { $quality = $this ->default_quality; } } // Allow 0, but squash to 1 due to identical images in GD, and for backward compatibility. if ( 0 === $quality ) { $quality = 1; } if ( ( $quality >= 1 ) && ( $quality <= 100 ) ) { $this ->quality = $quality ; return true; } else { return new WP_Error( 'invalid_image_quality' , __( 'Attempted to set image quality outside of the range [1,100].' ) ); } } /** * Returns preferred mime-type and extension based on provided * file's extension and mime, or current file's extension and mime. * * Will default to $this->default_mime_type if requested is not supported. * * Provides corrected filename only if filename is provided. * * @since 3.5.0 * * @param string $filename * @param string $mime_type * @return array { filename|null, extension, mime-type } */ protected function get_output_format( $filename = null, $mime_type = null ) { $new_ext = null; // By default, assume specified type takes priority. if ( $mime_type ) { $new_ext = $this ->get_extension( $mime_type ); } if ( $filename ) { $file_ext = strtolower ( pathinfo ( $filename , PATHINFO_EXTENSION ) ); $file_mime = $this ->get_mime_type( $file_ext ); } else { // If no file specified, grab editor's current extension and mime-type. $file_ext = strtolower ( pathinfo ( $this ->file, PATHINFO_EXTENSION ) ); $file_mime = $this ->mime_type; } // Check to see if specified mime-type is the same as type implied by // file extension. If so, prefer extension from file. if ( ! $mime_type || ( $file_mime == $mime_type ) ) { $mime_type = $file_mime ; $new_ext = $file_ext ; } // Double-check that the mime-type selected is supported by the editor. // If not, choose a default instead. if ( ! $this ->supports_mime_type( $mime_type ) ) { /** * Filters default mime type prior to getting the file extension. * * @see wp_get_mime_types() * * @since 3.5.0 * * @param string $mime_type Mime type string. */ $mime_type = apply_filters( 'image_editor_default_mime_type' , $this ->default_mime_type ); $new_ext = $this ->get_extension( $mime_type ); } if ( $filename ) { $dir = pathinfo ( $filename , PATHINFO_DIRNAME ); $ext = pathinfo ( $filename , PATHINFO_EXTENSION ); $filename = trailingslashit( $dir ) . wp_basename( $filename , ".$ext" ) . ".{$new_ext}" ; } return array ( $filename , $new_ext , $mime_type ); } /** * Builds an output filename based on current file, and adding proper suffix * * @since 3.5.0 * * @param string $suffix * @param string $dest_path * @param string $extension * @return string filename */ public function generate_filename( $suffix = null, $dest_path = null, $extension = null ) { // $suffix will be appended to the destination filename, just before the extension. if ( ! $suffix ) { $suffix = $this ->get_suffix(); } $dir = pathinfo ( $this ->file, PATHINFO_DIRNAME ); $ext = pathinfo ( $this ->file, PATHINFO_EXTENSION ); $name = wp_basename( $this ->file, ".$ext" ); $new_ext = strtolower ( $extension ? $extension : $ext ); if ( ! is_null ( $dest_path ) ) { $_dest_path = realpath ( $dest_path ); if ( $_dest_path ) { $dir = $_dest_path ; } } return trailingslashit( $dir ) . "{$name}-{$suffix}.{$new_ext}" ; } /** * Builds and returns proper suffix for file based on height and width. * * @since 3.5.0 * * @return string|false suffix */ public function get_suffix() { if ( ! $this ->get_size() ) { return false; } return "{$this->size['width']}x{$this->size['height']}" ; } /** * Check if a JPEG image has EXIF Orientation tag and rotate it if needed. * * @since 5.3.0 * * @return bool|WP_Error True if the image was rotated. False if not rotated (no EXIF data or the image doesn't need to be rotated). * WP_Error if error while rotating. */ public function maybe_exif_rotate() { $orientation = null; if ( is_callable ( 'exif_read_data' ) && 'image/jpeg' === $this ->mime_type ) { $exif_data = @exif_read_data( $this ->file ); if ( ! empty ( $exif_data [ 'Orientation' ] ) ) { $orientation = (int) $exif_data [ 'Orientation' ]; } } /** * Filters the `$orientation` value to correct it before rotating or to prevemnt rotating the image. * * @since 5.3.0 * * @param int $orientation EXIF Orientation value as retrieved from the image file. * @param string $file Path to the image file. */ $orientation = apply_filters( 'wp_image_maybe_exif_rotate' , $orientation , $this ->file ); if ( ! $orientation || 1 === $orientation ) { return false; } switch ( $orientation ) { case 2: // Flip horizontally. $result = $this ->flip( true, false ); break ; case 3: // Rotate 180 degrees or flip horizontally and vertically. // Flipping seems faster and uses less resources. $result = $this ->flip( true, true ); break ; case 4: // Flip vertically. $result = $this ->flip( false, true ); break ; case 5: // Rotate 90 degrees counter-clockwise and flip vertically. $result = $this ->rotate( 90 ); if ( ! is_wp_error( $result ) ) { $result = $this ->flip( false, true ); } break ; case 6: // Rotate 90 degrees clockwise (270 counter-clockwise). $result = $this ->rotate( 270 ); break ; case 7: // Rotate 90 degrees counter-clockwise and flip horizontally. $result = $this ->rotate( 90 ); if ( ! is_wp_error( $result ) ) { $result = $this ->flip( true, false ); } break ; case 8: // Rotate 90 degrees counter-clockwise. $result = $this ->rotate( 90 ); break ; } return $result ; } /** * Either calls editor's save function or handles file as a stream. * * @since 3.5.0 * * @param string|stream $filename * @param callable $function * @param array $arguments * @return bool */ protected function make_image( $filename , $function , $arguments ) { $stream = wp_is_stream( $filename ); if ( $stream ) { ob_start(); } else { // The directory containing the original file may no longer exist when using a replication plugin. wp_mkdir_p( dirname( $filename ) ); } $result = call_user_func_array( $function , $arguments ); if ( $result && $stream ) { $contents = ob_get_contents(); $fp = fopen ( $filename , 'w' ); if ( ! $fp ) { ob_end_clean(); return false; } fwrite( $fp , $contents ); fclose( $fp ); } if ( $stream ) { ob_end_clean(); } return $result ; } /** * Returns first matched mime-type from extension, * as mapped from wp_get_mime_types() * * @since 3.5.0 * * @param string $extension * @return string|false */ protected static function get_mime_type( $extension = null ) { if ( ! $extension ) { return false; } $mime_types = wp_get_mime_types(); $extensions = array_keys ( $mime_types ); foreach ( $extensions as $_extension ) { if ( preg_match( "/{$extension}/i" , $_extension ) ) { return $mime_types [ $_extension ]; } } return false; } /** * Returns first matched extension from Mime-type, * as mapped from wp_get_mime_types() * * @since 3.5.0 * * @param string $mime_type * @return string|false */ protected static function get_extension( $mime_type = null ) { $extensions = explode ( '|' , array_search ( $mime_type , wp_get_mime_types(), true ) ); if ( empty ( $extensions [0] ) ) { return false; } return $extensions [0]; } } |
Expand full source code View on Trac
Methods
- __construct — Each instance handles a single file.
- crop — Crops Image.
- flip — Flips current image.
- generate_filename — Builds an output filename based on current file, and adding proper suffix
- get_extension — Returns first matched extension from Mime-type, as mapped from wp_get_mime_types()
- get_mime_type — Returns first matched mime-type from extension, as mapped from wp_get_mime_types()
- get_output_format — Returns preferred mime-type and extension based on provided file’s extension and mime, or current file’s extension and mime.
- get_quality — Gets the Image Compression quality on a 1-100% scale.
- get_size — Gets dimensions of image.
- get_suffix — Builds and returns proper suffix for file based on height and width.
- load — Loads image from $this->file into editor.
- make_image — Either calls editor’s save function or handles file as a stream.
- maybe_exif_rotate — Check if a JPEG image has EXIF Orientation tag and rotate it if needed.
- multi_resize — Resize multiple images from a single source.
- resize — Resizes current image.
- rotate — Rotates current image counter-clockwise by $angle.
- save — Saves current image to file.
- set_quality — Sets Image Compression quality on a 1-100% scale.
- stream — Streams current image to browser.
- supports_mime_type — Checks to see if editor supports the mime-type specified.
- test — Checks to see if current environment supports the editor chosen.
- update_size — Sets current image size.
Changelog Changelog
Version | Description |
---|---|
3.5.0 | Introduced. |