wp_get_image_editor

函数
wp_get_image_editor ( $path, $args = array() )
参数
  • (string) $path Path to the file to load.
    Required:
  • (array) $args Optional. Additional arguments for retrieving the image editor. Default empty array.
    Required:
    Default: array()
返回值
  • (WP_Image_Editor|WP_Error) The WP_Image_Editor object on success, a WP_Error object otherwise.
定义位置
相关方法
wp_image_editorwp_ajax_image_editorwp_get_image_mimeget_image_send_to_editoredit_form_image_editor
引入
3.5.0
弃用
-

wp_get_image_editor: 这个函数用来创建一个WP_Image_Editor类的实例,该类用于在WordPress中操作图片。它接受一个图像文件路径作为唯一的参数,并返回一个WP_Image_Editor类的实例,可以用来执行各种图像操作任务。

返回一个WP_Image_Editor实例并将文件加载到其中。

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'] ) ) {
		/** This filter is documented in wp-includes/class-wp-image-editor.php */
		$output_format = apply_filters( 'image_editor_output_format', array(), $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.' ) );
}

常见问题

FAQs
查看更多 >