Changeset 59987

Timestamp:

03/16/2025 06:49:39 PM (5 weeks ago)

Author:

joedolson

Message:

Media: Add 'muted' attribute and normalize HTML attributes.

Add the 'muted' attribute to the audio shortcode. Fix boolean attributes to meet HTML5 standards. Replaces instances like attr="1" with attr for loop, autoplay, and muted, and improves handling of the preload attribute to only output valid values.

Props shub07, dmsnell, debarghyabanerjee, audrasjb, narenin, apermo, joedolson.
Fixes #61515.

Location:

trunk

Files:

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

trunk/src/wp-includes/media.php

@@ -3346 +3346 @@
  *
  * @since 3.6.0
+ * @since 6.8.0 Added the 'muted' attribute.
  *
  * @param array  $attr {
@@ -3353 +3354 @@
  *     @type string $loop     The 'loop' attribute for the `<audio>` element. Default empty.
  *     @type string $autoplay The 'autoplay' attribute for the `<audio>` element. Default empty.
+ *     @type string $muted    The 'muted' attribute for the `<audio>` element. Default 'false'.
  *     @type string $preload  The 'preload' attribute for the `<audio>` element. Default 'none'.
  *     @type string $class    The 'class' attribute for the `<audio>` element. Default 'wp-audio-shortcode'.
@@ -3391 +3393 @@
         'loop'     => '',
         'autoplay' => '',
+        'muted'    => 'false',
         'preload'  => 'none',
         'class'    => 'wp-audio-shortcode',
@@ -3470 +3473 @@
         'loop'     => wp_validate_boolean( $atts['loop'] ),
         'autoplay' => wp_validate_boolean( $atts['autoplay'] ),
+        'muted'    => wp_validate_boolean( $atts['muted'] ),
         'preload'  => $atts['preload'],
         'style'    => $atts['style'],
@@ -3475 +3479 @@
 
     // These ones should just be omitted altogether if they are blank.
-    foreach ( array( 'loop', 'autoplay', 'preload' ) as $a ) {
+    foreach ( array( 'loop', 'autoplay', 'preload', 'muted' ) as $a ) {
         if ( empty( $html_atts[ $a ] ) ) {
             unset( $html_atts[ $a ] );
@@ -3483 +3487 @@
     $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 a value.
+            $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 ) );
+            }
+        } else {
+            // For other attributes, include the value.
+            $attr_strings[] = sprintf( '%s="%s"', esc_attr( $attribute_name ), esc_attr( $attribute_value ) );
+        }
     }
 

trunk/tests/phpunit/tests/media.php

@@ -942 +942 @@
         $this->assertStringNotContainsString( 'loop', $actual );
         $this->assertStringNotContainsString( 'autoplay', $actual );
+        $this->assertStringNotContainsString( 'muted', $actual );
         $this->assertStringContainsString( 'preload="none"', $actual );
         $this->assertStringContainsString( 'class="wp-audio-shortcode"', $actual );
@@ -951 +952 @@
                 'loop'     => true,
                 'autoplay' => true,
-                'preload'  => true,
+                'muted'    => true,
+                'preload'  => 'none',
                 'class'    => 'foobar',
                 'style'    => 'padding:0;',
@@ -958 +960 @@
 
         $this->assertStringContainsString( 'src="https://example.com/foo.mp3', $actual );
-        $this->assertStringContainsString( 'loop="1"', $actual );
-        $this->assertStringContainsString( 'autoplay="1"', $actual );
-        $this->assertStringContainsString( 'preload="1"', $actual );
+        $this->assertStringContainsString( 'loop', $actual );
+        $this->assertStringContainsString( 'autoplay', $actual );
+        $this->assertStringContainsString( 'muted', $actual );
+        $this->assertStringContainsString( 'preload="none"', $actual );
         $this->assertStringContainsString( 'class="foobar"', $actual );
         $this->assertStringContainsString( 'style="padding:0;"', $actual );

trunk/tests/phpunit/tests/widgets/wpWidgetMediaAudio.php

@@ -273 +273 @@
         // Custom attributes.
         $this->assertStringContainsString( 'preload="auto"', $output );
-        $this->assertStringContainsString( 'loop="1"', $output );
+        $this->assertStringContainsString( 'loop', $output );
     }