Changeset 59367

Timestamp:

11/07/2024 01:25:10 AM (21 months ago)

Author:

peterwilsoncc

Message:

Media: Fix converting of all HEIC/HEIF images to JPEGs after uploading regardless of dimensions.

This backport includes follow up commits to improve a variable name and improve accuracy of when an image needs to be converted.

Reviewed by peterwilsoncc.
Merges [59317], [59346], [59366] to the 6.7 branch.

Props ironprogrammer, adamsilverstein, azaozz, peterwilsoncc, apermo, flixos90.
Fixes #62305.

Location:

branches/6.7

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/image.php (modified) (4 diffs)
• src/wp-includes/media.php (modified) (2 diffs)

branches/6.7/src/wp-admin/includes/image.php

@@ -292 +292 @@
                  * scale the image and use it as the "full" size.
                  */
+                $scale_down = false;
+                $convert    = false;
+
                 if ( $threshold && ( $image_meta['width'] > $threshold || $image_meta['height'] > $threshold ) ) {
+                        // The image will be converted if needed on saving.
+                        $scale_down = true;
+                } else {
+                        // The image may need to be converted regardless of its dimensions.
+                        $output_format = wp_get_image_editor_output_format( $file, $imagesize['mime'] );
+
+                        if (
+                                is_array( $output_format ) &&
+                                array_key_exists( $imagesize['mime'], $output_format ) &&
+                                $output_format[ $imagesize['mime'] ] !== $imagesize['mime']
+                        ) {
+                                $convert = true;
+                        }
+                }
+
+                if ( $scale_down || $convert ) {
                         $editor = wp_get_image_editor( $file );
 
@@ -300 +319 @@
                         }
 
-                        // Resize the image.
-                        $resized = $editor->resize( $threshold, $threshold );
+                        if ( $scale_down ) {
+                                // Resize the image. This will also convet it if needed.
+                                $resized = $editor->resize( $threshold, $threshold );
+                        } elseif ( $convert ) {
+                                // The image will be converted (if possible) when saved.
+                                $resized = true;
+                        }
+
                         $rotated = null;
 
@@ -307 +332 @@
                         if ( ! is_wp_error( $resized ) && is_array( $exif_meta ) ) {
                                 $resized = $editor->maybe_exif_rotate();
-                                $rotated = $resized;
+                                $rotated = $resized; // bool true or WP_Error
                         }
 
@@ -315 +340 @@
                                  * This doesn't affect the sub-sizes names as they are generated from the original image (for best quality).
                                  */
-                                $saved = $editor->save( $editor->generate_filename( 'scaled' ) );
+                                if ( $scale_down ) {
+                                        $saved = $editor->save( $editor->generate_filename( 'scaled' ) );
+                                } else {
+                                        $saved = $editor->save();
+                                }
 
                                 if ( ! is_wp_error( $saved ) ) {

branches/6.7/src/wp-includes/media.php

@@ -6234 +6234 @@
  */
 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,
-         * the mapping array is empty, so the mime type matches the source image.
+         * 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 array() to array( 'image/heic' => 'image/jpeg' ).
+         * @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.
@@ -6254 +6262 @@
          * @param string $mime_type The source image mime type.
          */
-        return apply_filters( 'image_editor_output_format', array( 'image/heic' => 'image/jpeg' ), $filename, $mime_type );
-}
+        return apply_filters( 'image_editor_output_format', $output_format, $filename, $mime_type );
+}