Changeset 57614

Timestamp:

02/13/2024 11:52:04 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Revisit the canonical location for the image_save_progressive filter.

This aims to bring consistency with the image_make_intermediate_size filter, which has the main DocBlock in WP_Image_Editor_GD::_save() and a duplicate hook reference in WP_Image_Editor_Imagick::_save().

Follow-up to [57607].

See #21668.

Location:

trunk/src/wp-includes

Files:

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

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

@@ -506 +506 @@
 
                 if ( function_exists( 'imageinterlace' ) ) {
-                        /** This filter is documented in wp-includes/class-wp-image-editor-imagick.php */
+                        /**
+                         * 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.
+                         */
                         imageinterlace( $image, apply_filters( 'image_save_progressive', false, $mime_type ) );
                 }

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

@@ -822 +822 @@
                 }
 
-                if ( method_exists( $this->image, 'setInterlaceScheme' ) && method_exists( $this->image, 'getInterlaceScheme' ) && defined( 'Imagick::INTERLACE_PLANE' ) ) {
+                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.
-                         */
+
+                        /** This filter is documented in wp-includes/class-wp-image-editor-imagick.php */
                         if ( apply_filters( 'image_save_progressive', false, $mime_type ) ) {
                                 $this->image->setInterlaceScheme( Imagick::INTERLACE_PLANE ); // True - line interlace output.
@@ -847 +844 @@
                         // Reset original format.
                         $this->image->setImageFormat( $orig_format );
+
                         if ( isset( $orig_interlace ) ) {
                                 $this->image->setInterlaceScheme( $orig_interlace );