Changeset 59473

Timestamp:

11/29/2024 11:46:50 PM (22 months ago)

Author:

adamsilverstein

Message:

Media: improve filter to enable setting output quality by image size.

Add a new $size parameter to the wp_editor_set_quality filter. $size is an array with 'width' and 'height' keys. Developers can use this information to set image quality based on the image size.

Props adamsilverstein, joemcgill, Mte90, codekraft, birgire, azaozz, sppramodh.
Fixes #54648.

Location:

trunk

Files:

• src/wp-includes/class-wp-image-editor-gd.php (modified) (3 diffs)
• src/wp-includes/class-wp-image-editor-imagick.php (modified) (2 diffs)
• src/wp-includes/class-wp-image-editor.php (modified) (2 diffs)
• tests/phpunit/tests/media.php (modified) (1 diff)

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

@@ -221 +221 @@
 
                 list( $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h ) = $dims;
+
+                $this->set_quality(
+                        null,
+                        array(
+                                'width'  => $dst_w,
+                                'height' => $dst_h,
+                        )
+                );
 
                 $resized = wp_imagecreatetruecolor( $dst_w, $dst_h );
@@ -569 +577 @@
          *
          * @since 6.7.0
-         *
-         * @param int $quality Compression Quality. Range: [1,100]
+         * @since 6.8.0 The `$dims` parameter was added.
+         *
+         * @param int   $quality Compression Quality. Range: [1,100]
+         * @param array $dims    Optional. Image dimensions array with 'width' and 'height' keys.
          * @return true|WP_Error True if set successfully; WP_Error on failure.
          */
-        public function set_quality( $quality = null ) {
-                $quality_result = parent::set_quality( $quality );
+        public function set_quality( $quality = null, $dims = array() ) {
+                $quality_result = parent::set_quality( $quality, $dims );
                 if ( is_wp_error( $quality_result ) ) {
                         return $quality_result;
@@ -587 +597 @@
                                 if ( ! empty( $webp_info['type'] ) && 'lossless' === $webp_info['type'] ) {
                                         $quality = IMG_WEBP_LOSSLESS;
-                                        parent::set_quality( $quality );
+                                        parent::set_quality( $quality, $dims );
                                 }
                         }

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

@@ -191 +191 @@
          *
          * @since 3.5.0
-         *
-         * @param int $quality Compression Quality. Range: [1,100]
+         * @since 6.8.0 The `$dims` parameter was added.
+         *
+         * @param int   $quality Compression Quality. Range: [1,100]
+         * @param array $dims    Optional. Image dimensions array with 'width' and 'height' keys.
          * @return true|WP_Error True if set successfully; WP_Error on failure.
          */
-        public function set_quality( $quality = null ) {
-                $quality_result = parent::set_quality( $quality );
+        public function set_quality( $quality = null, $dims = array() ) {
+                $quality_result = parent::set_quality( $quality, $dims );
                 if ( is_wp_error( $quality_result ) ) {
                         return $quality_result;
@@ -368 +370 @@
                 }
 
+                $this->set_quality(
+                        null,
+                        array(
+                                'width'  => $dst_w,
+                                'height' => $dst_h,
+                        )
+                );
+
                 // Execute the resize.
                 $thumb_result = $this->thumbnail_image( $dst_w, $dst_h );

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

@@ -241 +241 @@
          *
          * @since 3.5.0
-         *
-         * @param int $quality Compression Quality. Range: [1,100]
+         * @since 6.8.0 The `$dims` parameter was added.
+         *
+         * @param int   $quality Compression Quality. Range: [1,100]
+         * @param array $dims    Optional. Image dimensions array with 'width' and 'height' keys.
          * @return true|WP_Error True if set successfully; WP_Error on failure.
-         */
-        public function set_quality( $quality = null ) {
+
+         */
+        public function set_quality( $quality = null, $dims = array() ) {
                 // 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;
@@ -261 +264 @@
                          *
                          * @since 3.5.0
+                         * @since 6.8.0 Added the size parameter.
                          *
                          * @param int    $quality   Quality level between 1 (low) and 100 (high).
                          * @param string $mime_type Image mime type.
+                         * @param array $size {
+                         *     Dimensions of the image.
+                         *
+                         *     @type int $width  The image width.
+                         *     @type int $height The image height.
+                         * }
                          */
-                        $quality = apply_filters( 'wp_editor_set_quality', $default_quality, $mime_type );
+                        $quality = apply_filters( 'wp_editor_set_quality', $default_quality, $mime_type, $dims ? $dims : $this->size );
 
                         if ( 'image/jpeg' === $mime_type ) {

trunk/tests/phpunit/tests/media.php

@@ -5435 +5435 @@
 
         /**
+         * Test that the `wp_editor_set_quality` filter includes the dimensions in the `$dims` parameter.
+         *
+         * @ticket 54648
+         */
+        public function test_wp_editor_set_quality_includes_dimensions() {
+                // Before loading an image, set up the callback filter with the assertions.
+                add_filter( 'wp_editor_set_quality', array( $this, 'assert_dimensions_in_wp_editor_set_quality' ), 10, 3 );
+
+                $temp_dir = get_temp_dir();
+                $file     = $temp_dir . '/33772.jpg';
+                copy( DIR_TESTDATA . '/images/33772.jpg', $file );
+
+                $editor = wp_get_image_editor( $file );
+
+                $attachment_id = self::factory()->attachment->create_object(
+                        array(
+                                'post_mime_type' => 'image/jpeg',
+                                'file'           => $file,
+                        )
+                );
+
+                // Generate all sizes.
+                wp_generate_attachment_metadata( $attachment_id, $file );
+
+                // Clean up the filter.
+                remove_filter( 'wp_editor_set_quality', array( $this, 'assert_dimensions_in_wp_editor_set_quality' ), 10, 3 );
+        }
+
+        /**
+         * Helper callback to assert that the dimensions are included in the `$dims` parameter.
+         *
+         * @param int   $quality The quality level.
+         * @param array $dims    The dimensions array.
+         */
+        public function assert_dimensions_in_wp_editor_set_quality( $quality, $mime_type, $dims ) {
+                // Assert that the array has non empty width and height values.
+                $this->assertArrayHasKey( 'width', $dims );
+                $this->assertArrayHasKey( 'height', $dims );
+                $this->assertGreaterThan( 0, $dims['width'] );
+                $this->assertGreaterThan( 0, $dims['height'] );
+
+                return $quality;
+        }
+
+        /**
          * Test that an image size isn't generated if it matches the original image size.
          *