_wp_image_editor_choose( array $args = array() ): string|false

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarrayoptional

Array of arguments for choosing a capable editor. Default empty array.Default: array()

Return value

string|false

Class name for the first editor that claims to support the request.
False if no editor claims to support the request.

Performance profile

How much work a call to _wp_image_editor_choose() 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

Moderate

Only touches the object cache, via wp_cache_get().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

46–101

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 105.

Plugin surface

1 hook

Third-party callbacks on 'wp_image_editors' run inside this call, and their cost is not bounded by anything here.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()called directly
• serializeserialisationserialize()called directly

What one call costs · 9 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost _wp_image_editor_choose() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while _wp_image_editor_choose() runs, in this order:

1. 1
   apply_filters( wp_image_editors )filterline 4430 (+13 into the body)

   Filters the list of image editing library classes.

Uses · 3

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_cache_get()Retrieves the cache contents from the cache by key and group.
• wp_cache_set()Saves the data to the cache.

Used by · 3

• WP_Debug_Data::get_wp_media()Gets the WordPress media section of the debug data.
• wp_get_image_editor()Returns a WP_Image_Editor instance and loads file into it.
• wp_image_editor_supports()Tests whether there is an editor that supports a given mime type or methods.

Source code

View on Trac ↗View on GitHub ↗

4417function _wp_image_editor_choose( $args = array() ) {4418	require_once ABSPATH . WPINC . '/class-wp-image-editor.php';4419	require_once ABSPATH . WPINC . '/class-wp-image-editor-gd.php';4420	require_once ABSPATH . WPINC . '/class-wp-image-editor-imagick.php';4421	require_once ABSPATH . WPINC . '/class-avif-info.php';4422	/**4423	 * Filters the list of image editing library classes.4424	 *4425	 * @since 3.5.04426	 *4427	 * @param string[] $image_editors Array of available image editor class names. Defaults are4428	 *                                'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD'.4429	 */4430	$implementations = apply_filters( 'wp_image_editors', array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) );4431 4432	$editors = wp_cache_get( 'wp_image_editor_choose', 'image_editor' );4433 4434	if ( ! is_array( $editors ) ) {4435		$editors = array();4436	}4437 4438	// Cache the chosen editor implementation based on specific args and available implementations.4439	$cache_key = md5( serialize( array( $args, $implementations ) ) );4440 4441	if ( isset( $editors[ $cache_key ] ) ) {4442		return $editors[ $cache_key ];4443	}4444 4445	// Assume no support until a capable implementation is identified.4446	$editor = false;4447 4448	foreach ( $implementations as $implementation ) {4449		if ( ! call_user_func( array( $implementation, 'test' ), $args ) ) {4450			continue;4451		}4452 4453		// Implementation should support the passed mime type.4454		if ( isset( $args['mime_type'] ) &&4455			! call_user_func(4456				array( $implementation, 'supports_mime_type' ),4457				$args['mime_type']4458			) ) {4459			continue;4460		}4461 4462		// Implementation should support requested methods.4463		if ( isset( $args['methods'] ) &&4464			array_diff( $args['methods'], get_class_methods( $implementation ) ) ) {4465 4466			continue;4467		}4468 4469		// Implementation should ideally support the output mime type as well if set and different than the passed type.4470		if (4471			isset( $args['mime_type'] ) &&4472			isset( $args['output_mime_type'] ) &&4473			$args['mime_type'] !== $args['output_mime_type'] &&4474			! call_user_func( array( $implementation, 'supports_mime_type' ), $args['output_mime_type'] )4475		) {4476			/*4477			 * This implementation supports the input type but not the output type.4478			 * Keep looking to see if we can find an implementation that supports both.4479			 */4480			$editor = $implementation;4481			continue;4482		}4483 4484		// Favor the implementation that supports both input and output mime types.4485		$editor = $implementation;4486		break;4487	}4488 4489	$editors[ $cache_key ] = $editor;4490 4491	wp_cache_set( 'wp_image_editor_choose', $editors, 'image_editor', DAY_IN_SECONDS );4492 4493	return $editor;4494}

Changelog

Introduced in 3.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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.