Ticket #36982: 36982.5.diff

src/wp-includes/media.php

@@ -1063 +1063 @@
 
                         if ( is_array( $image_meta ) ) {
                                 $size_array = array( absint( $width ), absint( $height ) );
-                                $srcset     = wp_calculate_image_srcset( $size_array, $src, $image_meta, $attachment_id );
-                                $sizes      = wp_calculate_image_sizes( $size_array, $src, $image_meta, $attachment_id );
+                                $srcset     = wp_calculate_image_srcset( $size_array, $src, $image_meta, $attachment_id, $attr );
+                                $sizes      = wp_calculate_image_sizes( $size_array, $src, $image_meta, $attachment_id, $attr );
 
                                 if ( $srcset && ( $sizes || ! empty( $attr['sizes'] ) ) ) {
                                         $attr['srcset'] = $srcset;
@@ -1193 +1193 @@
  * Retrieves the value for an image attachment's 'srcset' attribute.
  *
  * @since 4.4.0
+ * @since 5.7.0 Added the '$image_attr' parameter.
  *
  * @see wp_calculate_image_srcset()
  *
@@ -1201 +1202 @@
  *                                    width and height values in pixels (in that order). Default 'medium'.
  * @param array        $image_meta    Optional. The image meta data as returned by 'wp_get_attachment_metadata()'.
  *                                    Default null.
+ * @param array        $image_attr    Optional. An array of image attributes to be passed to 'wp_calculate_image_srcset()'.
  * @return string|false A 'srcset' value string or false.
  */
-function wp_get_attachment_image_srcset( $attachment_id, $size = 'medium', $image_meta = null ) {
+function wp_get_attachment_image_srcset( $attachment_id, $size = 'medium', $image_meta = null, $image_attr = array() ) {
         $image = wp_get_attachment_image_src( $attachment_id, $size );
 
         if ( ! $image ) {
@@ -1220 +1222 @@
                 absint( $image[2] ),
         );
 
-        return wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id );
+        return wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id, $image_attr );
 }
 
 /**
  * A helper function to calculate the image sources to include in a 'srcset' attribute.
  *
  * @since 4.4.0
+ * @since 5.7.0 Added the '$image_attr' parameter.
  *
  * @param int[]  $size_array    {
  *     An array of width and height values.
@@ -1237 +1240 @@
  * @param string $image_src     The 'src' of the image.
  * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
  * @param int    $attachment_id Optional. The image attachment ID. Default 0.
+ * @param array  $image_attr    Optional. Image attributes.
+
  * @return string|false The 'srcset' attribute value. False on error or when only one source exists.
  */
-function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id = 0 ) {
+function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id = 0, $image_attr = array() ) {
         /**
          * Let plugins pre-filter the image meta to be able to fix inconsistencies in the stored data.
          *
@@ -1254 +1259 @@
          * }
          * @param string $image_src     The 'src' of the image.
          * @param int    $attachment_id The image attachment ID or 0 if not supplied.
+         * @param string $image_attr    The image attributes.
          */
-        $image_meta = apply_filters( 'wp_calculate_image_srcset_meta', $image_meta, $size_array, $image_src, $attachment_id );
+        $image_meta = apply_filters( 'wp_calculate_image_srcset_meta', $image_meta, $size_array, $image_src, $attachment_id, $image_attr );
 
         if ( empty( $image_meta['sizes'] ) || ! isset( $image_meta['file'] ) || strlen( $image_meta['file'] ) < 4 ) {
                 return false;
@@ -1413 +1419 @@
          * @param string $image_src     The 'src' of the image.
          * @param array  $image_meta    The image meta data as returned by 'wp_get_attachment_metadata()'.
          * @param int    $attachment_id Image attachment ID or 0.
+         * @param array  $image_attr    Image attributes.
          */
-        $sources = apply_filters( 'wp_calculate_image_srcset', $sources, $size_array, $image_src, $image_meta, $attachment_id );
+        $sources = apply_filters( 'wp_calculate_image_srcset', $sources, $size_array, $image_src, $image_meta, $attachment_id, $image_attr );
 
         // Only return a 'srcset' value if there is more than one source.
         if ( ! $src_matched || ! is_array( $sources ) || count( $sources ) < 2 ) {
@@ -1434 +1441 @@
  * Retrieves the value for an image attachment's 'sizes' attribute.
  *
  * @since 4.4.0
+ * @since 5.7.0 Added the '$image_attr' parameter.
  *
  * @see wp_calculate_image_sizes()
  *
@@ -1442 +1450 @@
  *                                    width and height values in pixels (in that order). Default 'medium'.
  * @param array        $image_meta    Optional. The image meta data as returned by 'wp_get_attachment_metadata()'.
  *                                    Default null.
+ * @param array        $image_attr    Optional. Image attributes.
  * @return string|false A valid source size value for use in a 'sizes' attribute or false.
  */
-function wp_get_attachment_image_sizes( $attachment_id, $size = 'medium', $image_meta = null ) {
+function wp_get_attachment_image_sizes( $attachment_id, $size = 'medium', $image_meta = null, $image_attr = array() ) {
         $image = wp_get_attachment_image_src( $attachment_id, $size );
 
         if ( ! $image ) {
@@ -1461 +1470 @@
                 absint( $image[2] ),
         );
 
-        return wp_calculate_image_sizes( $size_array, $image_src, $image_meta, $attachment_id );
+        return wp_calculate_image_sizes( $size_array, $image_src, $image_meta, $attachment_id, $image_attr );
 }
 
 /**
  * Creates a 'sizes' attribute value for an image.
  *
  * @since 4.4.0
+ * @since 5.7.0 Added the '$image_attr' parameter.
  *
  * @param string|int[] $size          Image size. Accepts any registered image size name, or an array of
  *                                    width and height values in pixels (in that order).
@@ -1476 +1486 @@
  *                                    Default null.
  * @param int          $attachment_id Optional. Image attachment ID. Either `$image_meta` or `$attachment_id`
  *                                    is needed when using the image size name as argument for `$size`. Default 0.
+ * @param array        $image_attr    Image attributes.
  * @return string|false A valid source size value for use in a 'sizes' attribute or false.
  */
-function wp_calculate_image_sizes( $size, $image_src = null, $image_meta = null, $attachment_id = 0 ) {
+function wp_calculate_image_sizes( $size, $image_src = null, $image_meta = null, $attachment_id = 0, $image_attr = array() ) {
         $width = 0;
 
         if ( is_array( $size ) ) {
@@ -1507 +1518 @@
          * Filters the output of 'wp_calculate_image_sizes()'.
          *
          * @since 4.4.0
+         * @since 5.7.0 Added the '$image_attr' parameter.
          *
          * @param string       $sizes         A source size value for use in a 'sizes' attribute.
          * @param string|int[] $size          Requested image size. Can be any registered image size name, or
@@ -1514 +1526 @@
          * @param string|null  $image_src     The URL to the image file or null.
          * @param array|null   $image_meta    The image meta data as returned by wp_get_attachment_metadata() or null.
          * @param int          $attachment_id Image attachment ID of the original image or 0.
+         * @param array        $image_attr    Image attributes.
          */
-        return apply_filters( 'wp_calculate_image_sizes', $sizes, $size, $image_src, $image_meta, $attachment_id );
+        return apply_filters( 'wp_calculate_image_sizes', $sizes, $size, $image_src, $image_meta, $attachment_id, $image_attr );
 }
 
 /**

tests/phpunit/tests/media.php

@@ -3164 +3164 @@
                         array( 'trash-attachment', '/?attachment_id=%ID%', false ),
                 );
         }
+
+        /**
+         * @ticket 36982
+         */
+        public function test_filter_image_srcset_and_sizes_by_image_attributes() {
+
+                $image_meta             = wp_get_attachment_metadata( self::$large_id );
+                $class_attribute_string = 'test-class-string test-image-full';
+
+                // Add a filter to remove srcset and sizes from the generated image.
+                add_filter( 'wp_calculate_image_srcset', '__return_false' );
+                add_filter( 'wp_calculate_image_sizes', '__return_false' );
+
+                $image_with_class_attribute_no_srcset_sizes    = wp_get_attachment_image(
+                        self::$large_id,
+                        'full',
+                        false,
+                        array(
+                                'class' => $class_attribute_string,
+                                'alt'   => 'Full size test image',
+                        )
+                );
+                $image_without_class_attribute_no_srcset_sizes = wp_get_attachment_image(
+                        self::$large_id,
+                        'full',
+                        false,
+                        array(
+                                'class' => '',
+                                'alt'   => 'Full size test image',
+                        )
+                );
+
+                // Remove the filter to restore srcset and sizes from the generated image.
+                remove_filter( 'wp_calculate_image_srcset', '__return_false' );
+                remove_filter( 'wp_calculate_image_sizes', '__return_false' );
+
+                $default_image_without_class_attribute         = wp_get_attachment_image(
+                        self::$large_id,
+                        'full',
+                        false,
+                        array(
+                                'class' => '',
+                                'alt'   => 'Full size test image',
+                        )
+                );
+                $default_srcset_string_without_class_attribute = wp_get_attachment_image_srcset(
+                        self::$large_id,
+                        'full',
+                        false,
+                        array(
+                                'class' => '',
+                                'alt'   => 'Full size test image',
+                        )
+                );
+                $default_sizes_string_without_class_attribute  = wp_get_attachment_image_sizes(
+                        self::$large_id,
+                        'full',
+                        false,
+                        array(
+                                'class' => '',
+                                'alt'   => 'Full size test image',
+                        )
+                );
+
+                // Filter the srcset and sizes values.
+                add_filter( 'wp_calculate_image_srcset', array( $this, '_filter_36982_srcset' ), 10, 6 );
+                add_filter( 'wp_calculate_image_sizes', array( $this, '_filter_36982_sizes' ), 10, 6 );
+
+                // Generate an image with srcset and sizes values that should match the filtered image.
+                $uploads_dir_url     = 'http://' . WP_TESTS_DOMAIN . '/wp-content/uploads/';
+                $image_file_date_dir = preg_replace( '/(\d{4}\/\d{2}\/).+/', '$1', $image_meta['file'] );
+
+                // Set sources that will match the filtered values.
+                $expected_sources = array(
+                        $image_meta['width'] => array(
+                                'url'        => $uploads_dir_url . $image_meta['file'],
+                                'descriptor' => 'w',
+                                'value'      => $image_meta['width'],
+                                'width'      => $image_meta['width'],
+                                'height'     => $image_meta['height'],
+                        ),
+                );
+
+                foreach ( $image_meta['sizes'] as $size ) {
+                        $expected_sources[ $size['width'] ] = array(
+                                'url'        => $uploads_dir_url . $image_file_date_dir . $size['file'],
+                                'descriptor' => 'w',
+                                'value'      => $size['width'],
+                                'width'      => $size['width'],
+                                'height'     => $size['height'],
+                        );
+                }
+
+                $expected_sources = array_slice(
+                        array_filter(
+                                array_map(
+                                        function( $source, $image_meta ) {
+                                                if ( ! wp_image_matches_ratio( $image_meta['width'], $image_meta['height'], $source['width'], $source['height'] ) || $source['value'] > apply_filters( 'max_srcset_image_width', 1600, array( $image_meta['width'], $image_meta['height'] ) ) ) {
+                                                          return false;
+                                                }
+                                                return $source['url'] . ' ' . $source['value'] . $source['descriptor'];
+                                        },
+                                        $expected_sources,
+                                        array_fill( 0, count( $expected_sources ), $image_meta )
+                                )
+                        ),
+                        2
+                );
+
+                // Set a sizes sting value that will match the arbitrary value set in the filter.
+                $expected_sizes_string = sprintf( '(max-width: %1$dpx) 100vw, %1$dpx', 9999 );
+
+                $expected_image = '<img width="' . $image_meta['width'] . '" height="' . $image_meta['height'] . '" src="' . $uploads_dir_url . $image_meta['file'] . '" class="' . $class_attribute_string . '" alt="Full size test image" srcset="' . implode( ', ', $expected_sources ) . '" sizes="' . $expected_sizes_string . '" />';
+
+                // Images without a class attribute that will match the test filter. Should match the default image with unfiltered srcset and sizes values.
+                $this->assertSame(
+                        $default_image_without_class_attribute,
+                        wp_get_attachment_image(
+                                self::$large_id,
+                                'full',
+                                false,
+                                array(
+                                        'class' => '',
+                                        'alt'   => 'Full size test image',
+                                )
+                        )
+                );
+                $this->assertSame( $default_image_without_class_attribute, wp_image_add_srcset_and_sizes( $image_without_class_attribute_no_srcset_sizes, $image_meta, self::$large_id ) );
+
+                // Images with a class attribute that will match the test filter. Should match the expected image with filtered srcset and sizes values.
+                $this->assertSame( $expected_image, wp_image_add_srcset_and_sizes( $image_with_class_attribute_no_srcset_sizes, $image_meta, self::$large_id ) );
+                $this->assertSame(
+                        $expected_image,
+                        wp_get_attachment_image(
+                                self::$large_id,
+                                'full',
+                                false,
+                                array(
+                                        'class' => $class_attribute_string,
+                                        'alt'   => 'Full size test image',
+                                )
+                        )
+                );
+
+                // Srcset and sizes strings with class attribute string. Should match the filtered string.
+                $this->assertSame(
+                        implode( ', ', $expected_sources ),
+                        wp_get_attachment_image_srcset(
+                                self::$large_id,
+                                'full',
+                                false,
+                                array(
+                                        'class' => $class_attribute_string,
+                                        'alt'   => 'Full size test image',
+                                )
+                        )
+                );
+                $this->assertSame(
+                        $expected_sizes_string,
+                        wp_get_attachment_image_sizes(
+                                self::$large_id,
+                                'full',
+                                false,
+                                array(
+                                        'class' => $class_attribute_string,
+                                        'alt'   => 'Full size test image',
+                                )
+                        )
+                );
+
+                // Srcset and sizes strings without class attribute string. Should match the unfiltered default string.
+                $this->assertSame(
+                        $default_srcset_string_without_class_attribute,
+                        wp_get_attachment_image_srcset(
+                                self::$large_id,
+                                'full',
+                                false,
+                                array(
+                                        'class' => '',
+                                        'alt'   => 'Full size test image',
+                                )
+                        )
+                );
+                $this->assertSame(
+                        $default_sizes_string_without_class_attribute,
+                        wp_get_attachment_image_sizes(
+                                self::$large_id,
+                                'full',
+                                false,
+                                array(
+                                        'class' => '',
+                                        'alt'   => 'Full size test image',
+                                )
+                        )
+                );
+
+        }
+
+        public function _filter_36982_srcset( $sources, $size_array, $image_src, $image_meta, $attachment_id, $image_attr ) {
+
+                if ( empty( $image_attr ) ) {
+                        return $sources;
+                }
+
+                if ( empty( $image_attr['class'] ) ) {
+                        return $sources;
+                }
+
+                $class_array = explode( ' ', $image_attr['class'] );
+
+                if ( in_array( 'test-image-full', $class_array, true ) ) {
+                        return array_slice( $sources, 2 );
+                }
+
+                return $sources;
+        }
+        public function _filter_36982_sizes( $sizes, $size_array, $image_src, $image_meta, $attachment_id, $image_attr ) {
+
+                if ( empty( $image_attr ) ) {
+                        return $sizes;
+                }
+
+                if ( empty( $image_attr['class'] ) ) {
+                        return $sizes;
+                }
+
+                $class_array = explode( ' ', $image_attr['class'] );
+
+                if ( in_array( 'test-image-full', $class_array, true ) ) {
+                        return sprintf( '(max-width: %1$dpx) 100vw, %1$dpx', 9999 );
+                }
+
+                return $sizes;
+        }
 }
 
 /**