Changeset 60415

Timestamp:

07/05/2025 06:55:29 PM (15 months ago)

Author:

adamsilverstein

Message:

Media: expose height and width attributes to the 'wp_get_attachment_image_attributes' filter.

Include the image height and width in the attributes passed to the 'wp_get_attachment_image_attributes' filter. Developers can use this to adjust the width and height attributes returned from the 'wp_get_attachment_image_attributes' function.

Props divinenephron, nacin, Sam_a, wpsmith, anatolbroder, ericlewis, puggan, SergeyBiryukov, spacedmonkey, adamsilverstein, flixos90, sandeepdahiya, SirLouen.
Fixes #14110.

Location:

trunk

Files:

• src/wp-includes/media.php (modified) (3 diffs)
• tests/phpunit/tests/media.php (modified) (1 diff)

trunk/src/wp-includes/media.php

@@ -1071 +1071 @@
 
                 $attachment = get_post( $attachment_id );
-                $hwstring   = image_hwstring( $width, $height );
                 $size_class = $size;
 
@@ -1091 +1090 @@
                  * @param string $context The context. Default 'wp_get_attachment_image'.
                  */
-                $context = apply_filters( 'wp_get_attachment_image_context', 'wp_get_attachment_image' );
-                $attr    = wp_parse_args( $attr, $default_attr );
-
-                $loading_attr              = $attr;
-                $loading_attr['width']     = $width;
-                $loading_attr['height']    = $height;
+                $context        = apply_filters( 'wp_get_attachment_image_context', 'wp_get_attachment_image' );
+                $attr           = wp_parse_args( $attr, $default_attr );
+                $attr['width']  = $width;
+                $attr['height'] = $height;
+
                 $loading_optimization_attr = wp_get_loading_optimization_attributes(
                         'img',
-                        $loading_attr,
+                        $attr,
                         $context
                 );
@@ -1170 +1168 @@
                 $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment, $size );
 
-                $attr = array_map( 'esc_attr', $attr );
-                $html = rtrim( "<img $hwstring" );
+                if ( isset( $attr['height'] ) && is_numeric( $attr['height'] ) ) {
+                        $height = absint( $attr['height'] );
+                }
+                if ( isset( $attr['width'] ) && is_numeric( $attr['width'] ) ) {
+                        $width = absint( $attr['width'] );
+                }
+                unset( $attr['height'], $attr['width'] );
+                $attr     = array_map( 'esc_attr', $attr );
+                $hwstring = image_hwstring( $width, $height );
+                $html     = rtrim( "<img $hwstring" );
 
                 foreach ( $attr as $name => $value ) {

trunk/tests/phpunit/tests/media.php

@@ -1582 +1582 @@
 
                 $this->assertSame( $expected, $output );
+        }
+
+        /**
+         * @ticket 14110
+         */
+        public function test_wp_get_attachment_image_filter_with_height_width() {
+                $mock_action = new MockAction();
+                add_filter( 'wp_get_attachment_image_attributes', array( $mock_action, 'filter' ) );
+                wp_get_attachment_image( self::$large_id );
+                $args = $mock_action->get_args();
+                $this->assertArrayHasKey( '0', $args, 'First argument should be an array.' );
+                $this->assertArrayHasKey( '0', $args[0], 'First argument should be an array.' );
+                $this->assertArrayHasKey( 'width', $args[0][0], 'Width should be set.' );
+                $this->assertArrayHasKey( 'height', $args[0][0], 'Height should be set.' );
+        }
+
+        /**
+         * @ticket 14110
+         */
+        public function test_wp_get_attachment_image_filter_change_height_width() {
+                add_filter(
+                        'wp_get_attachment_image_attributes',
+                        static function ( $args ) {
+                                $args['height'] = '999';
+                                $args['width']  = '999';
+                                return $args;
+                        }
+                );
+                $output = wp_get_attachment_image( self::$large_id );
+                $this->assertStringContainsString( 'width="999"', $output, 'Width should be changed.' );
+                $this->assertStringContainsString( 'height="999"', $output, 'Height should be changed.' );
+        }
+
+        /**
+         * @ticket 14110
+         */
+        public function test_wp_get_attachment_image_filter_unset_height_width() {
+                add_filter(
+                        'wp_get_attachment_image_attributes',
+                        static function ( $args ) {
+                                unset( $args['height'], $args['width'] );
+                                return $args;
+                        }
+                );
+                $output = wp_get_attachment_image( self::$large_id );
+                $this->assertStringContainsString( 'width="150"', $output, 'Width should not be changed.' );
+                $this->assertStringContainsString( 'height="150"', $output, 'Height should not be changed.' );
         }