Changeset 57607

Timestamp:

02/12/2024 11:24:19 PM (3 years ago)

Author:

adamsilverstein

Message:

Media: enable control of progressive image output.

Add a new image_save_progressive filter which developers can use to control whether intermediate image sizes are saved in a progressive format (when available). By default, progressive image output is not used, matching the previous behavior.

Props: adamsilverstein, _ck_, markoheijnen, SergeyBiryukov, Japh, pmeenan, mikeschroder, derekspringer, buley, ericlewis, bahia0019, born2webdesign.
Fixes #21668.

Location:

trunk/src/wp-includes

Files:

• class-wp-image-editor-gd.php (modified) (1 diff)
• class-wp-image-editor-imagick.php (modified) (3 diffs)

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

@@ -503 +503 @@
                 if ( ! $filename ) {
                         $filename = $this->generate_filename( null, null, $extension );
+                }
+
+                if ( function_exists( 'imageinterlace' ) ) {
+                        /** This filter is documented in wp-includes/class-wp-image-editor-imagick.php */
+                        imageinterlace( $image, apply_filters( 'image_save_progressive', false, $mime_type ) );
                 }
 

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

@@ -490 +490 @@
                                 }
                         }
-
-                        if ( is_callable( array( $this->image, 'setInterlaceScheme' ) ) && defined( 'Imagick::INTERLACE_NO' ) ) {
-                                $this->image->setInterlaceScheme( Imagick::INTERLACE_NO );
-                        }
                 } catch ( Exception $e ) {
                         return new WP_Error( 'image_resize_error', $e->getMessage() );
@@ -826 +822 @@
                 }
 
+                if ( method_exists( $this->image, 'setInterlaceScheme' ) && method_exists( $this->image, 'getInterlaceScheme' ) && defined( 'Imagick::INTERLACE_PLANE' ) ) {
+                        $orig_interlace = $this->image->getInterlaceScheme();
+                        /**
+                         * Filters whether to output progressive images (if available).
+                         *
+                         * @since 6.5.0
+                         *
+                         * @param bool   $interlace Whether to use progressive images for output if available. Default false.
+                         * @param string $mime_type The mime type being saved.
+                         */
+                        if ( apply_filters( 'image_save_progressive', false, $mime_type ) ) {
+                                $this->image->setInterlaceScheme( Imagick::INTERLACE_PLANE ); // True - line interlace output.
+                        } else {
+                                $this->image->setInterlaceScheme( Imagick::INTERLACE_NO ); // False - no interlace output.
+                        }
+                }
+
                 $write_image_result = $this->write_image( $this->image, $filename );
                 if ( is_wp_error( $write_image_result ) ) {
@@ -834 +847 @@
                         // Reset original format.
                         $this->image->setImageFormat( $orig_format );
+                        if ( isset( $orig_interlace ) ) {
+                                $this->image->setInterlaceScheme( $orig_interlace );
+                        }
                 } catch ( Exception $e ) {
                         return new WP_Error( 'image_save_error', $e->getMessage(), $filename );