Ticket #56442: 56442.3.diff

src/wp-includes/class-wp-image-editor.php

@@ -261 +261 @@
          * @return true|WP_Error True if set successfully; WP_Error on failure.
          */
         public function set_quality( $quality = null ) {
+
                 // Use the output mime type if present. If not, fall back to the input/initial mime type.
                 $mime_type = ! empty( $this->output_mime_type ) ? $this->output_mime_type : $this->mime_type;
                 // Get the default quality setting for the mime type.
@@ -439 +440 @@
                         // The image will be converted when saving. Set the quality for the new mime-type if not already set.
                         if ( $mime_type !== $this->output_mime_type ) {
                                 $this->output_mime_type = $mime_type;
-                                $this->set_quality();
                         }
+                        $this->set_quality();
                 } elseif ( ! empty( $this->output_mime_type ) ) {
                         // Reset output_mime_type and quality.
                         $this->output_mime_type = null;

tests/phpunit/tests/image/editor.php

@@ -125 +125 @@
          * @ticket 6821
          */
         public function test_set_quality_with_image_conversion() {
+                remove_filter( 'image_editor_output_format', 'wp_default_image_output_mapping' );
+
                 $editor = wp_get_image_editor( DIR_TESTDATA . '/images/test-image.png' );
                 $editor->set_mime_type( 'image/png' ); // Ensure mime-specific filters act properly.
 
+                // Quality setting for the source image. For PNG the fallback default of 82 is used.
+                $this->assertSame( 82, $editor->get_quality(), 'Default quality setting is 82.' );
+
                 // Set conversions for uploaded images.
                 add_filter( 'image_editor_output_format', array( $this, 'image_editor_output_formats' ) );
 
                 // Quality setting for the source image. For PNG the fallback default of 82 is used.
                 $this->assertSame( 82, $editor->get_quality(), 'Default quality setting is 82.' );
 
-                // Quality should change to the output format's value.
-                // A PNG image will be converted to WEBP whose quialty should be 86.
+                // When saving, quality should change to the output format's value.
+                // A PNG image will be converted to WEBP whose quality should be 86.
+                $editor->save();
+                $this->assertSame( 86, $editor->get_quality(), 'Output image format is WEBP. Quality setting for it should be 86.' );
+
+                // Saving again should not change the quality.
                 $editor->save();
                 $this->assertSame( 86, $editor->get_quality(), 'Output image format is WEBP. Quality setting for it should be 86.' );
 
@@ -160 +169 @@
                 // Quality should change to the output format's value as filtered above.
                 // A JPEG image will be converted to WEBP whose quialty should be 42.
                 $editor->save();
-                $this->assertSame( 42, $editor->get_quality(), 'Image conversion from JPEG to WEBP. Filtered WEBP quality shoild be 42.' );
+                $this->assertSame( 42, $editor->get_quality(), 'Image conversion from JPEG to WEBP. Filtered WEBP quality should be 42.' );
 
                 // After removing the conversion the quality setting should reset to the filtered value for the original image type, JPEG.
                 remove_filter( 'image_editor_output_format', array( $this, 'image_editor_output_formats' ) );

tests/phpunit/tests/media.php

@@ -3748 +3748 @@
                         ),
                 );
         }
+
+
+        /**
+         * Test that generated files with the `image_editor_output_format` applied use the correct
+         * quality level based on the ir mime type.
+         *
+         * @ticket 56442
+         */
+        public function test_quality_with_image_conversion_file_sizes() {
+                if ( ! wp_image_editor_supports( array( 'mime_type' => 'image/webp' ) ) ) {
+                        $this->markTestSkipped( 'WebP is not supported on this system.' );
+                }
+                add_filter( 'image_editor_output_format', array( $this, 'image_editor_output_jpeg' ) );
+                $temp_dir = get_temp_dir();
+                $file     = $temp_dir . '/33772.jpg';
+                copy( DIR_TESTDATA . '/images/33772.jpg', $file );
+
+                // Set JPEG output quality very low and WebP quality very high, this should force all generated WebP images to
+                // be larger than the the matching generated JPEGs.
+                add_filter( 'wp_editor_set_quality', array( $this, 'image_editor_change_quality_low_jpeg' ), 10, 2 );
+
+                $editor = wp_get_image_editor( $file );
+
+                // Verify that the selected editor actually supports WebP output.
+                if ( ! $editor->supports_mime_type( 'image/webp' ) ) {
+                        $this->markTestSkipped( 'WebP is not supported by the selected image editor.' );
+                }
+
+                $attachment_id = self::factory()->attachment->create_object(
+                        $file,
+                        0,
+                        array(
+                                'post_mime_type' => 'image/jpeg',
+                        )
+                );
+
+                add_filter( 'big_image_size_threshold', array( $this, 'add_big_image_size_threshold' ) );
+
+                // Generate all sizes as JPEGs.
+                $jpeg_sizes = wp_generate_attachment_metadata( $attachment_id, $file );
+                remove_filter( 'image_editor_output_format', array( $this, 'image_editor_output_jpeg' ) );
+
+                // Generate all sizes as WebP.
+                add_filter( 'image_editor_output_format', array( $this, 'image_editor_output_webp' ) );
+                $webp_sizes = wp_generate_attachment_metadata( $attachment_id, $file );
+                remove_filter( 'image_editor_output_format', array( $this, 'image_editor_output_webp' ) );
+
+                // The main (scaled) image: the JPEG should be smaller than the WebP.
+                $this->assertLessThan( $webp_sizes['filesize'], $jpeg_sizes['filesize'] );
+
+                // Sub-sizes: for each size, the JPEGs should be smaller than the WebP.
+                $sizes_to_compare = array_intersect_key( $jpeg_sizes['sizes'], $webp_sizes['sizes'] );
+                foreach ( $sizes_to_compare as $size => $size_data ) {
+                        $this->assertLessThan( $webp_sizes['sizes'][ $size ]['filesize'], $jpeg_sizes['sizes'][ $size ]['filesize'] );
+                }
+
+                // Cleanup.
+                remove_filter( 'wp_editor_set_quality', array( $this, 'image_editor_change_quality_low_jpeg' ), 10, 2 );
+                remove_filter( 'big_image_size_threshold', array( $this, 'add_big_image_size_threshold' ) );
+        }
+
+        /**
+         * Add threshold to create a `-scaled` output image for testing.
+         */
+        public function add_big_image_size_threshold() {
+                return 1000;
+        }
+
+        /**
+         * Output JPEG files.
+         */
+        public function image_editor_output_jpeg() {
+                return array( 'image/jpeg' => 'image/jpeg' );
+        }
+
+        /**
+         * Output WebP files.
+         */
+        public function image_editor_output_webp() {
+                return array( 'image/jpeg' => 'image/webp' );
+        }
+
+        /**
+         * Changes the quality using very low quality for JPEGs and very high quality
+         * for WebPs, used to verify the filter is applying correctly.
+         *
+         * @param int    $quality   Default quality.
+         * @param string $mime_type Image mime-type.
+         * @return int The changed quality.
+         */
+        public function image_editor_change_quality_low_jpeg( $quality, $mime_type ) {
+                if ( 'image/jpeg' === $mime_type ) {
+                        return 1;
+                } elseif ( 'image/webp' === $mime_type ) {
+                        return 100;
+                } else {
+                        return 30;
+                }
+        }
+
 }
 
 /**