Changeset 53292

Timestamp:

04/27/2022 05:19:52 AM (3 years ago)

Author:

peterwilsoncc

Message:

Media: Ensure wp_crop_image() returns correct file type.

Return the correct file path from wp_crop_image() when a developer modifies the file type with via the image_editor_output_format filter.

Previously the function would return a broken file reference containing the original file extension rather than the one specified via the filter.

Props mat-lipe, adamsilverstein.
Fixes #55403.

Location:

trunk

Files:

• src/wp-admin/includes/image.php (modified) (1 diff)
• tests/phpunit/tests/image/functions.php (modified) (3 diffs)

trunk/src/wp-admin/includes/image.php

@@ -62 +62 @@
     if ( is_wp_error( $result ) ) {
         return $result;
+    }
+
+    if ( ! empty( $result['path'] ) ) {
+        return $result['path'];
     }
 

trunk/tests/phpunit/tests/image/functions.php

@@ -144 +144 @@
     }
 
-
     /**
      * @ticket 50833
@@ -342 +341 @@
 
         return $classes;
+    }
+
+    /**
+     * @ticket 55403
+     */
+    public function test_wp_crop_image_with_filtered_extension() {
+        add_filter( 'image_editor_output_format', array( $this, 'filter_image_editor_output_format' ) );
+        $file = wp_crop_image(
+            DIR_TESTDATA . '/images/canola.jpg',
+            0,
+            0,
+            100,
+            100,
+            100,
+            100
+        );
+
+        $this->assertNotWPError( $file );
+        $this->assertFileExists( $file );
+
+        unlink( $file );
     }
 
@@ -660 +680 @@
     }
 
+    public function filter_image_editor_output_format() {
+        return array_fill_keys( array( 'image/jpg', 'image/jpeg', 'image/png' ), 'image/webp' );
+    }
+
     public function filter_fallback_intermediate_image_sizes( $fallback_sizes, $metadata ) {
         // Add the 'test-size' to the list of fallback sizes.