wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_get_image_editor › WordPress Function

Since3.5.0
Deprecatedn/a
› wp_get_image_editor ( $path, $args = array() )
Parameters: (2)
  • (string) $path Path to the file to load.
    Required: Yes
  • (array) $args Optional. Additional arguments for retrieving the image editor. Default empty array.
    Required: No
    Default: array()
Returns:
  • (WP_Image_Editor|WP_Error) The WP_Image_Editor object on success, a WP_Error object otherwise.
Defined at:
Codex:

Returns a WP_Image_Editor instance and loads file into it.



Related Functions: wp_image_editor, wp_ajax_image_editor, wp_get_image_mime, get_image_send_to_editor, edit_form_image_editor

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.' ) );
}