WP_Image_Editor

14#[AllowDynamicProperties]15abstract class WP_Image_Editor {16	protected $file              = null;17	protected $size              = null;18	protected $mime_type         = null;19	protected $output_mime_type  = null;20	protected $default_mime_type = 'image/jpeg';21	protected $quality           = false;22 23	// Deprecated since 5.8.1. See get_default_quality() below.24	protected $default_quality = 82;25 26	/**27	 * Each instance handles a single file.28	 *29	 * @param string $file Path to the file to load.30	 */31	public function __construct( $file ) {32		$this->file = $file;33	}34 35	/**36	 * Checks to see if current environment supports the editor chosen.37	 * Must be overridden in a subclass.38	 *39	 * @since 3.5.040	 *41	 * @abstract42	 *43	 * @param array $args44	 * @return bool45	 */46	public static function test( $args = array() ) {47		return false;48	}49 50	/**51	 * Checks to see if editor supports the mime-type specified.52	 * Must be overridden in a subclass.53	 *54	 * @since 3.5.055	 *56	 * @abstract57	 *58	 * @param string $mime_type59	 * @return bool60	 */61	public static function supports_mime_type( $mime_type ) {62		return false;63	}64 65	/**66	 * Loads image from $this->file into editor.67	 *68	 * @since 3.5.069	 * @abstract70	 *71	 * @return true|WP_Error True if loaded; WP_Error on failure.72	 */73	abstract public function load();74 75	/**76	 * Saves current image to file.77	 *78	 * @since 3.5.079	 * @since 6.0.0 The `$filesize` value was added to the returned array.80	 * @abstract81	 *82	 * @param string $destfilename Optional. Destination filename. Default null.83	 * @param string $mime_type    Optional. The mime-type. Default null.84	 * @return array|WP_Error {85	 *     Array on success or WP_Error if the file failed to save.86	 *87	 *     @type string $path      Path to the image file.88	 *     @type string $file      Name of the image file.89	 *     @type int    $width     Image width.90	 *     @type int    $height    Image height.91	 *     @type string $mime-type The mime type of the image.92	 *     @type int    $filesize  File size of the image.93	 * }