wp_image_editor_supports( string|array $args = array() ): bool
- Since
- 3.5.0
- Source
wp-includes/media.php:4403
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
$argsstring|arrayoptional- Array of arguments to retrieve the image editor supports.
Default empty array.Default:array()
Return value
bool- True if an eligible editor is found; false otherwise.
Performance profile
How much work a call to wp_image_editor_supports() 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
- 6
- Plugin surface
- None
- Called by
- 7
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. The body compiles to 6.
Nothing here hands control to plugin code.
7 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_image_editor_supports() - cacheobject cache
wp_cache_get()one call below wp_image_editor_supports()
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_image_editor_supports() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 6 | _wp_image_editor_choose() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 6 instructions, 6 executed per call, 0 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 · 1
- _wp_image_editor_choose()Tests which editors are capable of supporting the request.
Used by · 7
- WP_REST_Attachments_Controller::create_item_permissions_check()Checks if a given request has access to create an attachment.
- edit_form_image_editor()Displays the image and editor in the post editor
- get_media_item()Retrieves HTML form for modifying the image attachment.
- media_upload_form()Outputs the legacy media upload form.
- wp_image_editor()Loads the WP image-editing interface.
- wp_plupload_default_settings()Prints default Plupload arguments.
- wp_show_heic_upload_error()Callback to enable showing of the user error when uploading .heic images.
Source code
function wp_image_editor_supports( $args = array() ) { return (bool) _wp_image_editor_choose( $args );}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 7.1.0 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.