Changeset 59346

Timestamp:

11/05/2024 04:07:45 AM (2 years ago)

Author:

azaozz

Message:

Media: Better variable name and some docs fixes for the new wp_get_image_editor_output_format().

Props peterwilsoncc, apermo, azaozz.
See #62305.

File:

• trunk/src/wp-includes/media.php (modified) (3 diffs)

trunk/src/wp-includes/media.php

@@ -6234 +6234 @@
  */
 function wp_get_image_editor_output_format( $filename, $mime_type ) {
-        $default_output_format = array(
+        $output_format = array(
                 'image/heic'          => 'image/jpeg',
                 'image/heif'          => 'image/jpeg',
@@ -6250 +6250 @@
          *
          * @since 5.8.0
-         * @since 6.7.0 The default was changed from empty array to array containing the HEIC mime types.
+         * @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. Default maps uploaded HEIC images to JPEG output.
+         *     destination mime type. By default maps HEIC/HEIF input to JPEG output.
          *
          *     @type string ...$0 The new mime type.
@@ -6261 +6262 @@
          * @param string $mime_type The source image mime type.
          */
-        return apply_filters( 'image_editor_output_format', $default_output_format, $filename, $mime_type );
-}
+        return apply_filters( 'image_editor_output_format', $output_format, $filename, $mime_type );
+}