Changeset 59954

Timestamp:

03/09/2025 09:14:28 AM (19 months ago)

Author:

audrasjb

Message:

Media: Improve HTML5 compliance of wp_video_shortcode() boolean attributes.

This changeset updates wp_video_shortcode() to improve boolean attributes handling in accordance with HTML5 standards. Technically, it replaces attr="1" with attr for the loop, autoplay and muted attributes. The preload attribute is also updated to accept only allowed values: none, metadata, and auto. If a value outside of this list is provided, it will be ignored, preventing invalid attribute outputs.

Props jongycastillo, sabernhardt, joedolson, audrasjb, shub07, debarghyabanerjee.
Fixes #60178.

Location:

trunk

Files:

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

trunk/src/wp-includes/media.php

@@ -3483 +3483 @@
         $attr_strings = array();
 
-        foreach ( $html_atts as $k => $v ) {
-                $attr_strings[] = $k . '="' . esc_attr( $v ) . '"';
+        foreach ( $html_atts as $attribute_name => $attribute_value ) {
+                if ( in_array( $attribute_name, array( 'loop', 'autoplay', 'muted' ), true ) && true === $attribute_value ) {
+                        // Add boolean attributes without their value for true.
+                        $attr_strings[] = esc_attr( $attribute_name );
+                } elseif ( 'preload' === $attribute_name && ! empty( $attribute_value ) ) {
+                        // Handle the preload attribute with specific allowed values.
+                        $allowed_preload_values = array( 'none', 'metadata', 'auto' );
+                        if ( in_array( $attribute_value, $allowed_preload_values, true ) ) {
+                                $attr_strings[] = sprintf( '%s="%s"', esc_attr( $attribute_name ), esc_attr( $attribute_value ) );
+                        }
+                } elseif ( ! empty( $attribute_value ) ) {
+                        // For non-boolean attributes, add them with their value.
+                        $attr_strings[] = sprintf( '%s="%s"', esc_attr( $attribute_name ), esc_attr( $attribute_value ) );
+                }
         }
 

trunk/tests/phpunit/tests/media.php

@@ -1061 +1061 @@
                                 'autoplay' => true,
                                 'muted'    => true,
-                                'preload'  => true,
+                                'preload'  => 'metadata',
                                 'width'    => 123,
                                 'height'   => 456,
@@ -1070 +1070 @@
                 $this->assertStringContainsString( 'src="https://example.com/foo.mp4', $actual );
                 $this->assertStringContainsString( 'poster="https://example.com/foo.png', $actual );
-                $this->assertStringContainsString( 'loop="1"', $actual );
-                $this->assertStringContainsString( 'autoplay="1"', $actual );
+                $this->assertStringContainsString( 'loop', $actual );
+                $this->assertStringContainsString( 'autoplay', $actual );
                 $this->assertStringContainsString( 'muted', $actual );
-                $this->assertStringContainsString( 'preload="1"', $actual );
+                $this->assertStringContainsString( 'preload="metadata"', $actual );
                 $this->assertStringContainsString( 'width="123"', $actual );
                 $this->assertStringContainsString( 'height="456"', $actual );

trunk/tests/phpunit/tests/widgets/wpWidgetMediaVideo.php

@@ -278 +278 @@
                 // Custom attributes.
                 $this->assertStringContainsString( 'preload="metadata"', $output );
-                $this->assertStringContainsString( 'loop="1"', $output );
+                $this->assertStringContainsString( 'loop', $output );
 
                 // Externally hosted video.