Changeset 55171

Timestamp:

01/31/2023 07:39:51 PM (4 years ago)

Author:

flixos90

Message:

Media: Allow to omit decoding="async" on tags from wp_get_attachment_image().

When adding decoding="async" to images was introduced in [53480], it did not provide the ability to customize that behavior specifically for image tags returned from wp_get_attachment_image().

With this changeset it is now possible to explicitly provide a decoding value of e.g. boolean false in the $attr parameter of the function, to ensure the attribute is omitted.

Props maximej, adamsilverstein, flixos90, costdev, peterwilsoncc, mukesh27.
Fixes #57086.

Location:

trunk

Files:

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

trunk/src/wp-includes/media.php

@@ -1024 +1024 @@
  *                                  Defaults to 'lazy', depending on wp_lazy_loading_enabled().
  *     @type string       $decoding The 'decoding' attribute value. Possible values are
- *                                  'async' (default), 'sync', or 'auto'.
+ *                                  'async' (default), 'sync', or 'auto'. Passing false or an empty
+ *                                  string will result in the attribute being omitted.
  * }
  * @return string HTML img element or empty string on failure.
@@ -1056 +1057 @@
 
                 $attr = wp_parse_args( $attr, $default_attr );
+
+                // Omit the `decoding` attribute if the value is invalid according to the spec.
+                if ( empty( $attr['decoding'] ) || ! in_array( $attr['decoding'], array( 'async', 'sync', 'auto' ), true ) ) {
+                        unset( $attr['decoding'] );
+                }
 
                 // If the default value of `lazy` for the `loading` attribute is overridden

trunk/tests/phpunit/tests/media.php

@@ -3280 +3280 @@
 
         /**
+         * @ticket 57086
+         *
+         * @dataProvider data_wp_get_attachment_image_decoding_attr
+         *
+         * @covers ::wp_get_attachment_image
+         */
+        public function test_wp_get_attachment_image_decoding_attr( $decoding, $expected ) {
+                if ( 'no value' === $decoding ) {
+                        $image = wp_get_attachment_image( self::$large_id, 'thumbnail', false, array() );
+                } else {
+                        $image = wp_get_attachment_image( self::$large_id, 'thumbnail', false, array( 'decoding' => $decoding ) );
+                }
+
+                if ( 'no value' === $expected ) {
+                        $this->assertStringNotContainsString( ' decoding=', $image );
+                } else {
+                        $this->assertStringContainsString( ' decoding="' . esc_attr( $expected ) . '"', $image );
+                }
+        }
+
+        /**
+         * Data provider for test_wp_get_attachment_image_decoding_attr().
+         *
+         * @return array[]
+         */
+        public function data_wp_get_attachment_image_decoding_attr() {
+                return array(
+                        'default'     => array(
+                                'decoding' => 'no value',
+                                'expected' => 'async',
+                        ),
+                        'async'       => array(
+                                'decoding' => 'async',
+                                'expected' => 'async',
+                        ),
+                        'sync'        => array(
+                                'decoding' => 'sync',
+                                'expected' => 'sync',
+                        ),
+                        'auto'        => array(
+                                'decoding' => 'auto',
+                                'expected' => 'auto',
+                        ),
+                        'empty'       => array(
+                                'decoding' => '',
+                                'expected' => 'no value',
+                        ),
+                        'false'       => array(
+                                'decoding' => false,
+                                'expected' => 'no value',
+                        ),
+                        'null'        => array(
+                                'decoding' => null,
+                                'expected' => 'no value',
+                        ),
+                        'zero'        => array(
+                                'decoding' => 0,
+                                'expected' => 'no value',
+                        ),
+                        'zero string' => array(
+                                'decoding' => '0',
+                                'expected' => 'no value',
+                        ),
+                        'zero float'  => array(
+                                'decoding' => 0.0,
+                                'expected' => 'no value',
+                        ),
+                        'invalid'     => array(
+                                'decoding' => 'invalid',
+                                'expected' => 'no value',
+                        ),
+                );
+        }
+
+        /**
          * @ticket 44427
          * @ticket 50425