<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[59987] trunk: Media: Add 'muted' attribute and normalize HTML attributes.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/59987">59987</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/59987","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joedolson</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-03-16 18:49:39 +0000 (Sun, 16 Mar 2025)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/61515">#61515</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/media.php</a></li>
<li><a href="#trunktestsphpunittestsmediaphp">trunk/tests/phpunit/tests/media.php</a></li>
<li><a href="#trunktestsphpunittestswidgetswpWidgetMediaAudiophp">trunk/tests/phpunit/tests/widgets/wpWidgetMediaAudio.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesmediaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/media.php 2025-03-16 16:09:13 UTC (rev 59986)
+++ trunk/src/wp-includes/media.php 2025-03-16 18:49:39 UTC (rev 59987)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3345,6 +3345,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * WordPress mp3s in a post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.8.0 Added the 'muted' attribute.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $attr {
</span><span class="cx" style="display: block; padding: 0 10px"> * Attributes of the audio shortcode.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3352,6 +3353,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $src URL to the source of the audio file. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $loop The 'loop' attribute for the `<audio>` element. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $autoplay The 'autoplay' attribute for the `<audio>` element. Default empty.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $muted The 'muted' attribute for the `<audio>` element. Default 'false'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $preload The 'preload' attribute for the `<audio>` element. Default 'none'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $class The 'class' attribute for the `<audio>` element. Default 'wp-audio-shortcode'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $style The 'style' attribute for the `<audio>` element. Default 'width: 100%;'.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3390,6 +3392,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'src' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'loop' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'autoplay' => '',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'muted' => 'false',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'preload' => 'none',
</span><span class="cx" style="display: block; padding: 0 10px"> 'class' => 'wp-audio-shortcode',
</span><span class="cx" style="display: block; padding: 0 10px"> 'style' => 'width: 100%;',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3469,12 +3472,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'id' => sprintf( 'audio-%d-%d', $post_id, $instance ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'loop' => wp_validate_boolean( $atts['loop'] ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'autoplay' => wp_validate_boolean( $atts['autoplay'] ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'muted' => wp_validate_boolean( $atts['muted'] ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'preload' => $atts['preload'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'style' => $atts['style'],
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // These ones should just be omitted altogether if they are blank.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( array( 'loop', 'autoplay', 'preload' ) as $a ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( array( 'loop', 'autoplay', 'preload', 'muted' ) as $a ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $html_atts[ $a ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $html_atts[ $a ] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3482,8 +3486,20 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $attr_strings = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $html_atts as $k => $v ) {
- $attr_strings[] = $k . '="' . esc_attr( $v ) . '"';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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 ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $html = '';
</span></span></pre></div>
<a id="trunktestsphpunittestsmediaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/media.php 2025-03-16 16:09:13 UTC (rev 59986)
+++ trunk/tests/phpunit/tests/media.php 2025-03-16 18:49:39 UTC (rev 59987)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -941,6 +941,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringContainsString( 'src="https://example.com/foo.mp3', $actual );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringNotContainsString( 'loop', $actual );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringNotContainsString( 'autoplay', $actual );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertStringNotContainsString( 'muted', $actual );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringContainsString( 'preload="none"', $actual );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringContainsString( 'class="wp-audio-shortcode"', $actual );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringContainsString( 'style="width: 100%;"', $actual );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -950,7 +951,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'src' => 'https://example.com/foo.mp3',
</span><span class="cx" style="display: block; padding: 0 10px"> 'loop' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'autoplay' => true,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'preload' => true,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'muted' => true,
+ 'preload' => 'none',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'class' => 'foobar',
</span><span class="cx" style="display: block; padding: 0 10px"> 'style' => 'padding:0;',
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -957,9 +959,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringContainsString( 'src="https://example.com/foo.mp3', $actual );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertStringContainsString( 'loop="1"', $actual );
- $this->assertStringContainsString( 'autoplay="1"', $actual );
- $this->assertStringContainsString( 'preload="1"', $actual );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertStringContainsString( 'loop', $actual );
+ $this->assertStringContainsString( 'autoplay', $actual );
+ $this->assertStringContainsString( 'muted', $actual );
+ $this->assertStringContainsString( 'preload="none"', $actual );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringContainsString( 'class="foobar"', $actual );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringContainsString( 'style="padding:0;"', $actual );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestswidgetswpWidgetMediaAudiophp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/widgets/wpWidgetMediaAudio.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/widgets/wpWidgetMediaAudio.php 2025-03-16 16:09:13 UTC (rev 59986)
+++ trunk/tests/phpunit/tests/widgets/wpWidgetMediaAudio.php 2025-03-16 18:49:39 UTC (rev 59987)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -272,7 +272,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Custom attributes.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertStringContainsString( 'preload="auto"', $output );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertStringContainsString( 'loop="1"', $output );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertStringContainsString( 'loop', $output );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre>
</div>
</div>
</body>
</html>