W3cubDocs

/WordPress

WP_Image_Editor::get_output_format( string $filename = null, string $mime_type = null )

Returns preferred mime-type and extension based on provided file’s extension and mime, or current file’s extension and mime.

Description

Will default to $this->default_mime_type if requested is not supported.

Provides corrected filename only if filename is provided.

Parameters

$filename

(string) (Optional)

Default value: null

$mime_type

(string) (Optional)

Default value: null

Return

(array) filename|null, extension, mime-type

Source

File: wp-includes/class-wp-image-editor.php 

protected function get_output_format( $filename = null, $mime_type = null ) {
		$new_ext = null;

		// By default, assume specified type takes priority.
		if ( $mime_type ) {
			$new_ext = $this->get_extension( $mime_type );
		}

		if ( $filename ) {
			$file_ext  = strtolower( pathinfo( $filename, PATHINFO_EXTENSION ) );
			$file_mime = $this->get_mime_type( $file_ext );
		} else {
			// If no file specified, grab editor's current extension and mime-type.
			$file_ext  = strtolower( pathinfo( $this->file, PATHINFO_EXTENSION ) );
			$file_mime = $this->mime_type;
		}

		// Check to see if specified mime-type is the same as type implied by
		// file extension. If so, prefer extension from file.
		if ( ! $mime_type || ( $file_mime == $mime_type ) ) {
			$mime_type = $file_mime;
			$new_ext   = $file_ext;
		}

		// Double-check that the mime-type selected is supported by the editor.
		// If not, choose a default instead.
		if ( ! $this->supports_mime_type( $mime_type ) ) {
			/**
			 * Filters default mime type prior to getting the file extension.
			 *
			 * @see wp_get_mime_types()
			 *
			 * @since 3.5.0
			 *
			 * @param string $mime_type Mime type string.
			 */
			$mime_type = apply_filters( 'image_editor_default_mime_type', $this->default_mime_type );
			$new_ext   = $this->get_extension( $mime_type );
		}

		if ( $filename ) {
			$dir = pathinfo( $filename, PATHINFO_DIRNAME );
			$ext = pathinfo( $filename, PATHINFO_EXTENSION );

			$filename = trailingslashit( $dir ) . wp_basename( $filename, ".$ext" ) . ".{$new_ext}";
		}

		return array( $filename, $new_ext, $mime_type );
	}

Uses

Uses Description
wp-includes/formatting.php: wp_basename()

i18n friendly version of basename()
wp-includes/formatting.php: trailingslashit()

Appends a trailing slash.
wp-includes/class-wp-image-editor.php: WP_Image_Editor::get_extension()

Returns first matched extension from Mime-type, as mapped from wp_get_mime_types()
wp-includes/class-wp-image-editor.php: WP_Image_Editor::get_mime_type()

Returns first matched mime-type from extension, as mapped from wp_get_mime_types()
wp-includes/class-wp-image-editor.php: image_editor_default_mime_type

Filters default mime type prior to getting the file extension.
wp-includes/class-wp-image-editor.php: WP_Image_Editor::supports_mime_type()

Checks to see if editor supports the mime-type specified.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Changelog

Version Description
3.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_image_editor/get_output_format