wp_get_image_editor_output_format( string $filename, string $mime_type ): array<string,

Compatibility

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

Parameters

$filenamestring

Path to the image.

$mime_typestring

The source image mime type.

Return value

array<string,

string> An array of mime type mappings.

Performance profile

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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

10

Executed per call on PHP 8.5. The body compiles to 10.

Plugin surface

1 hook

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

Called by

5

5 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

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_get_image_editor_output_format() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

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

1. 1
   apply_filters( image_editor_output_format )filterline 6567 (+25 into the body)

   Filters the image editor output format mapping.

Uses · 1

• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 5

• WP_Debug_Data::get_wp_media()Gets the WordPress media section of the debug data.
• WP_Image_Editor::get_output_format()Returns preferred mime-type and extension based on provided file's extension and mime, or current file's extension and mime.
• wp_create_image_subsizes()Creates image sub-sizes, adds the new data to the image meta `sizes` array, and updates the image metadata.
• wp_get_image_editor()Returns a WP_Image_Editor instance and loads file into it.
• wp_unique_filename()Gets a filename that is sanitized and unique for the given directory.

Source code

View on Trac ↗View on GitHub ↗

6542function wp_get_image_editor_output_format( $filename, $mime_type ) {6543	$output_format = array(6544		'image/heic'          => 'image/jpeg',6545		'image/heif'          => 'image/jpeg',6546		'image/heic-sequence' => 'image/jpeg',6547		'image/heif-sequence' => 'image/jpeg',6548	);6549 6550	/**6551	 * Filters the image editor output format mapping.6552	 *6553	 * Enables filtering the mime type used to save images. By default HEIC/HEIF images6554	 * are converted to JPEGs.6555	 *6556	 * @see WP_Image_Editor::get_output_format()6557	 *6558	 * @since 5.8.06559	 * @since 6.7.0 The default was changed from an empty array to an array6560	 *              containing the HEIC/HEIF images mime types.6561	 *6562	 * @param array<string, string> $output_format An array of mime type mappings. Maps a source mime type to a new6563	 *                                             destination mime type. By default maps HEIC/HEIF input to JPEG output.6564	 * @param string                $filename      Path to the image.6565	 * @param string                $mime_type     The source image mime type.6566	 */6567	return apply_filters( 'image_editor_output_format', $output_format, $filename, $mime_type );6568}

Changelog

Introduced in 6.7.0. One change between 6.7.7 and 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.