<!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>[55171] trunk: Media: Allow to omit `decoding="async"` on tags from `wp_get_attachment_image()`.</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/55171">55171</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/55171","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>flixos90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-01-31 19:39:51 +0000 (Tue, 31 Jan 2023)</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: Allow to omit `decoding="async"` on tags from `wp_get_attachment_image()`.
When adding `decoding="async"` to images was introduced in <a href="https://core.trac.wordpress.org/changeset/53480">[53480]</a>, 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 <a href="https://core.trac.wordpress.org/ticket/57086">#57086</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>
</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 2023-01-31 17:48:45 UTC (rev 55170)
+++ trunk/src/wp-includes/media.php 2023-01-31 19:39:51 UTC (rev 55171)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1023,7 +1023,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * will result in the attribute being omitted for the image.
</span><span class="cx" style="display: block; padding: 0 10px"> * Defaults to 'lazy', depending on wp_lazy_loading_enabled().
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $decoding The 'decoding' attribute value. Possible values are
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 'async' (default), 'sync', or 'auto'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 'async' (default), 'sync', or 'auto'. Passing false or an empty
+ * string will result in the attribute being omitted.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string HTML img element or empty string on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1056,6 +1057,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $attr = wp_parse_args( $attr, $default_attr );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 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'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // If the default value of `lazy` for the `loading` attribute is overridden
</span><span class="cx" style="display: block; padding: 0 10px"> // to omit the attribute for this image, ensure it is not included.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( array_key_exists( 'loading', $attr ) && ! $attr['loading'] ) {
</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 2023-01-31 17:48:45 UTC (rev 55170)
+++ trunk/tests/phpunit/tests/media.php 2023-01-31 19:39:51 UTC (rev 55171)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3279,6 +3279,81 @@
</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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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',
+ ),
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 44427
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 50425
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 50756
</span></span></pre>
</div>
</div>
</body>
</html>