云策 WordPress 开发者社区

函数文档

wp_get_image_editor_output_format()

查看官方原文 ↗
💡 云策文档标注

概述

wp_get_image_editor_output_format() 函数用于确定图像编辑器的输出格式映射，主要处理 HEIC/HEIF 格式图像转换为 JPEG 的默认行为。该函数返回一个 MIME 类型映射数组，并可通过 'image_editor_output_format' 过滤器进行自定义。

关键要点

  • 函数返回一个数组，映射源 MIME 类型到目标 MIME 类型，默认将 HEIC/HEIF 格式转换为 JPEG。
  • 接受两个必需参数：$filename（图像路径）和 $mime_type（源图像 MIME 类型）。
  • 提供 'image_editor_output_format' 过滤器，允许开发者修改输出格式映射。
  • 自 WordPress 6.7.0 版本引入，默认映射从空数组改为包含 HEIC/HEIF 转换。

代码示例

function wp_get_image_editor_output_format( $filename, $mime_type ) {
	$output_format = array(
		'image/heic'          => 'image/jpeg',
		'image/heif'          => 'image/jpeg',
		'image/heic-sequence' => 'image/jpeg',
		'image/heif-sequence' => 'image/jpeg',
	);

	return apply_filters( 'image_editor_output_format', $output_format, $filename, $mime_type );
}

注意事项

  • 此函数主要用于内部调用，如 WP_Image_Editor::get_output_format()，开发者通常通过过滤器进行自定义。
  • 在修改映射时，需确保目标 MIME 类型与图像编辑器支持的格式兼容。
📄 原文内容

Determines the output format for the image editor.

Parameters

$filenamestringrequired
Path to the image.
$mime_typestringrequired
The source image mime type.

Return

string[] An array of mime type mappings.

Source

function wp_get_image_editor_output_format( $filename, $mime_type ) {
	$output_format = array(
		'image/heic'          => 'image/jpeg',
		'image/heif'          => 'image/jpeg',
		'image/heic-sequence' => 'image/jpeg',
		'image/heif-sequence' => 'image/jpeg',
	);

	/**
	 * Filters the image editor output format mapping.
	 *
	 * Enables filtering the mime type used to save images. By default HEIC/HEIF images
	 * are converted to JPEGs.
	 *
	 * @see WP_Image_Editor::get_output_format()
	 *
	 * @since 5.8.0
	 * @since 6.7.0 The default was changed from an empty array to an array
	 *              containing the HEIC/HEIF images mime types.
	 *
	 * @param string[] $output_format {
	 *     An array of mime type mappings. Maps a source mime type to a new
	 *     destination mime type. By default maps HEIC/HEIF input to JPEG output.
	 *
	 *     @type string ...$0 The new mime type.
	 * }
	 * @param string $filename  Path to the image.
	 * @param string $mime_type The source image mime type.
	 */
	return apply_filters( 'image_editor_output_format', $output_format, $filename, $mime_type );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘image_editor_output_format’, string[] $output_format, string $filename, string $mime_type )

Filters the image editor output format mapping.

Uses Description
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
Used by Description
WP_Debug_Data::get_wp_media()wp-admin/includes/class-wp-debug-data.php

Gets the WordPress media section of the debug data.
wp_create_image_subsizes()wp-admin/includes/image.php

Creates image sub-sizes, adds the new data to the image meta sizes array, and updates the image metadata.
wp_unique_filename()wp-includes/functions.php

Gets a filename that is sanitized and unique for the given directory.
WP_Image_Editor::get_output_format()wp-includes/class-wp-image-editor.php

Returns preferred mime-type and extension based on provided file’s extension and mime, or current file’s extension and mime.
wp_get_image_editor()wp-includes/media.php

Returns a WP_Image_Editor instance and loads file into it.

Changelog

Version Description
6.7.0 Introduced.