Changeset 54416

Timestamp:

10/07/2022 07:01:32 PM (2 years ago)

Author:

adamsilverstein

Message:

Media: improve image engine detection when using the output format filter.

When the output format is altered with the image_editor_output_format filter, prefer the image engine that supports both input an output types, falling back to the engine that supports the input type.

Correct an issue where the output format filter wasn't respected because the selected engine didn't support the output format.

Props mikeschroder, ironprogrammer.
Fixes #54476.

File:

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

trunk/src/wp-includes/media.php

@@ -3839 +3839 @@
     $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'] );
@@ -3849 +3850 @@
     }
 
+    // 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 );
 
@@ -3901 +3911 @@
      */
     $implementations = apply_filters( 'wp_image_editors', array( 'WP_Image_Editor_Imagick', 'WP_Image_Editor_GD' ) );
+    $supports_input  = false;
 
     foreach ( $implementations as $implementation ) {
@@ -3907 +3918 @@
         }
 
+        // Implementation should support the passed mime type.
         if ( isset( $args['mime_type'] ) &&
             ! call_user_func(
@@ -3915 +3927 @@
         }
 
+        // Implementation should support requested methods.
         if ( isset( $args['methods'] ) &&
             array_diff( $args['methods'], get_class_methods( $implementation ) ) ) {
@@ -3921 +3934 @@
         }
 
+        // Implementation should ideally support the output mime type as well if set and different than the passed type.
+        if (
+            isset( $args['mime_type'] ) &&
+            isset( $args['output_mime_type'] ) &&
+            $args['mime_type'] !== $args['output_mime_type'] &&
+            ! call_user_func( array( $implementation, 'supports_mime_type' ), $args['output_mime_type'] )
+        ) {
+            // This implementation supports the imput type but not the output type.
+            // Keep looking to see if we can find an implementation that supports both.
+            $supports_input = $implementation;
+            continue;
+        }
+
+        // Favor the implementation that supports both input and output mime types.
         return $implementation;
     }
 
-    return false;
+    return $supports_input;
 }