wp_get_image_editor( string $path, array $args = array() ): WP_Image_Editor|WP_Error

Returns a WP_Image_Editor instance and loads file into it.

Parameters

$pathstringrequired: Path to the file to load.
$argsarrayoptional: Additional arguments for retrieving the image editor.

Default:array()

Return

WP_Image_Editor|WP_Error The WP_Image_Editor object on success, a WP_Error object otherwise.

Source

function wp_get_image_editor( $path, $args = array() ) {
	$args['path'] = $path;

	// If the mime type is not set in args, try to extract and set it from the file.
	if ( ! isset( $args['mime_type'] ) ) {
		$file_info = wp_check_filetype( $args['path'] );

		/*
		 * If $file_info['type'] is false, then we let the editor attempt to
		 * figure out the file type, rather than forcing a failure based on extension.
		 */
		if ( isset( $file_info ) && $file_info['type'] ) {
			$args['mime_type'] = $file_info['type'];
		}
	}

	// Check and set the output mime type mapped to the input type.
	if ( isset( $args['mime_type'] ) ) {
		$output_format = wp_get_image_editor_output_format( $path, $args['mime_type'] );
		if ( isset( $output_format[ $args['mime_type'] ] ) ) {
			$args['output_mime_type'] = $output_format[ $args['mime_type'] ];
		}
	}

	$implementation = _wp_image_editor_choose( $args );

	if ( $implementation ) {
		$editor = new $implementation( $path );
		$loaded = $editor->load();

		if ( is_wp_error( $loaded ) ) {
			return $loaded;
		}

		return $editor;
	}

	return new WP_Error( 'image_no_editor', __( 'No editor could be selected.' ) );
}

View all references View on Trac View on GitHub

Uses	Description
wp_get_image_editor_output_format()`wp-includes/media.php`	Determines the output format for the image editor.
wp_check_filetype()`wp-includes/functions.php`	Retrieves the file type from the file name.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
is_wp_error()`wp-includes/load.php`	Checks whether the given variable is a WordPress Error.
WP_Error::__construct()`wp-includes/class-wp-error.php`	Initializes the error.

Show 3 more Show less

Used by	Description
wp_getimagesize()`wp-includes/media.php`	Allows PHP’s getimagesize() to be debuggable when necessary.
WP_REST_Attachments_Controller::edit_media_item()`wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php`	Applies edits to a media item and creates a new attachment record.
wp_create_image_subsizes()`wp-admin/includes/image.php`	Creates image sub-sizes, adds the new data to the image meta `sizes` array, and updates the image metadata.
_wp_make_subsizes()`wp-admin/includes/image.php`	Low-level function to create image sub-sizes.
stream_preview_image()`wp-admin/includes/image-edit.php`	Streams image in post to browser, along with enqueued changes in `$_REQUEST['history']`.
wp_save_image()`wp-admin/includes/image-edit.php`	Saves image to post, along with enqueued changes in `$_REQUEST['history']`.
wp_generate_attachment_metadata()`wp-admin/includes/image.php`	Generates attachment meta data and create image sub-sizes for images.
wp_crop_image()`wp-admin/includes/image.php`	Crops an image to a given size.
image_resize()`wp-includes/deprecated.php`	Scale down an image to fit a particular size and save a new copy of the image.
image_make_intermediate_size()`wp-includes/media.php`	Resizes an image to make a thumbnail or intermediate size.

Show 5 more Show less

Changelog

Version	Description
3.5.0	Introduced.

User Contributed Notes

Skip to note 3 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note
Basic Example
```
$image = wp_get_image_editor( 'cool_image.jpg' );
if ( ! is_wp_error( $image ) ) {
    $image->rotate( 90 );
    $image->resize( 300, 300, true );
    $image->save( 'new_image.jpg' );
}
```
Log in to add feedback
Skip to note 4 content

Hyppolite T. 1 year ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Example: Check a broken image
```
$image = wp_get_image_editor( 'my_image.jpg' );
if ( is_wp_error( $image ) ) {
  //do some action, like add image path and name to an array of broken images.
}
```
Log in to add feedback

You must log in before being able to contribute a note or feedback.