wp_get_image_editor( string $path, array $args = array() ): WP_Image_Editor|WP_Error
- Since
- 3.5.0
- Source
wp-includes/media.php:4165
Compatibility
- WordPress
- since 3.5.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$pathstring- Path to the file to load.
$argsarrayoptional- Additional arguments for retrieving the image editor.
Default empty array.Default:array()
Return value
WP_Image_Editor|WP_Error- The WP_Image_Editor object on success, a WP_Error object otherwise.
Performance profile
How much work a call to wp_get_image_editor() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Light
- Scaling
- Constant
- Instructions
- 21–53
- Plugin surface
- None
- Called by
- 10
Only touches the object cache, via wp_cache_get().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 62.
Nothing here hands control to plugin code.
10 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below wp_get_image_editor() - cacheobject cache
wp_cache_get()one call below wp_get_image_editor()
Further down the call graph this can also reach query, option, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_image_editor() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 21 | _wp_image_editor_choose(), __() |
| always | 26 | _wp_image_editor_choose(), ->load(), is_wp_error() |
!isset($args) | 29–34 | wp_check_filetype(), _wp_image_editor_choose(), __() |
isset($args) | 31–35 | wp_get_image_editor_output_format(), _wp_image_editor_choose(), __() |
!isset($args) | 34–39 | wp_check_filetype(), _wp_image_editor_choose(), ->load(), is_wp_error() |
isset($args) | 36–40 | wp_get_image_editor_output_format(), _wp_image_editor_choose(), ->load(), is_wp_error() |
| always | 39–48 | wp_check_filetype(), wp_get_image_editor_output_format(), _wp_image_editor_choose(), __() |
| always | 44–53 | wp_check_filetype(), wp_get_image_editor_output_format(), _wp_image_editor_choose(), ->load(), is_wp_error() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 62 instructions, 21–53 executed per call, 7 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 6
- wp_check_filetype()Retrieves the file type from the file name.
- wp_get_image_editor_output_format()Determines the output format for the image editor.
- _wp_image_editor_choose()Tests which editors are capable of supporting the request.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- __()Retrieves the translation of $text.
- WP_Error::__construct()Initializes the error.
Used by · 10
- WP_REST_Attachments_Controller::edit_media_item()Applies edits to a media item and creates a new attachment record.
- _wp_make_subsizes()Low-level function to create image sub-sizes.
- image_make_intermediate_size()Resizes an image to make a thumbnail or intermediate size.
- image_resize()Scale down an image to fit a particular size and save a new copy of the image.
- stream_preview_image()Streams image in post to browser, along with enqueued changes in `$_REQUEST['history']`.
- wp_create_image_subsizes()Creates image sub-sizes, adds the new data to the image meta `sizes` array, and updates the image metadata.
- wp_crop_image()Crops an image to a given size.
- wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.
- wp_getimagesize()Allows PHP's getimagesize() to be debuggable when necessary.
- wp_save_image()Saves image to post, along with enqueued changes in `$_REQUEST['history']`.
Source code
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.' ) );}Changelog
Introduced in 3.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/media.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.