<!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>[56154] trunk: Media: Ensure that the image widget supports loading optimization 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/56154">56154</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/56154","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-07-06 16:31:02 +0000 (Thu, 06 Jul 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: Ensure that the image widget supports loading optimization attributes.

This changeset adds support for loading optimization attributes such as `loading="lazy"` and `fetchpriority="high"` to the image widget. A new context `widget_media_image` is introduced for that purpose.

Props spacedmonkey, thekt12, mukesh27, westonruter.
Fixes <a href="https://core.trac.wordpress.org/ticket/58704">#58704</a>.
See <a href="https://core.trac.wordpress.org/ticket/58235">#58235</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/media.php</a></li>
<li><a href="#trunksrcwpincludeswidgetsclasswpwidgetmediaimagephp">trunk/src/wp-includes/widgets/class-wp-widget-media-image.php</a></li>
<li><a href="#trunktestsphpunittestsmediaphp">trunk/tests/phpunit/tests/media.php</a></li>
<li><a href="#trunktestsphpunittestswidgetswpWidgetMediaImagephp">trunk/tests/phpunit/tests/widgets/wpWidgetMediaImage.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-07-06 14:15:00 UTC (rev 56153)
+++ trunk/src/wp-includes/media.php     2023-07-06 16:31:02 UTC (rev 56154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5662,7 +5662,7 @@
</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">        // Special handling for programmatically created image tags.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        if ( 'the_post_thumbnail' === $context || 'wp_get_attachment_image' === $context ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'the_post_thumbnail' === $context || 'wp_get_attachment_image' === $context || 'widget_media_image' === $context ) {
</ins><span class="cx" style="display: block; padding: 0 10px">                 /*
</span><span class="cx" style="display: block; padding: 0 10px">                 * Skip programmatically created images within post content as they need to be handled together with the other
</span><span class="cx" style="display: block; padding: 0 10px">                 * images within the post content.
</span></span></pre></div>
<a id="trunksrcwpincludeswidgetsclasswpwidgetmediaimagephp"></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/widgets/class-wp-widget-media-image.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/widgets/class-wp-widget-media-image.php     2023-07-06 14:15:00 UTC (rev 56153)
+++ trunk/src/wp-includes/widgets/class-wp-widget-media-image.php       2023-07-06 16:31:02 UTC (rev 56154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -239,14 +239,31 @@
</span><span class="cx" style="display: block; padding: 0 10px">                                $instance['height'] = '';
</span><span class="cx" style="display: block; padding: 0 10px">                        }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                        $image = sprintf(
-                               '<img class="%1$s" src="%2$s" alt="%3$s" width="%4$s" height="%5$s" />',
-                               esc_attr( $classes ),
-                               esc_url( $instance['url'] ),
-                               esc_attr( $instance['alt'] ),
-                               esc_attr( $instance['width'] ),
-                               esc_attr( $instance['height'] )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                 $attr = array(
+                               'class'    => $classes,
+                               'src'      => $instance['url'],
+                               'alt'      => $instance['alt'],
+                               'width'    => $instance['width'],
+                               'height'   => $instance['height'],
+                               'decoding' => 'async',
</ins><span class="cx" style="display: block; padding: 0 10px">                         );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+                       $loading_optimization_attr = wp_get_loading_optimization_attributes(
+                               'img',
+                               $attr,
+                               'widget_media_image'
+                       );
+
+                       $attr = array_merge( $attr, $loading_optimization_attr );
+
+                       $attr  = array_map( 'esc_attr', $attr );
+                       $image = '<img';
+
+                       foreach ( $attr as $name => $value ) {
+                               $image .= ' ' . $name . '="' . $value . '"';
+                       }
+
+                       $image .= ' />';
</ins><span class="cx" style="display: block; padding: 0 10px">                 } // End if().
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                $url = '';
</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-07-06 14:15:00 UTC (rev 56153)
+++ trunk/tests/phpunit/tests/media.php 2023-07-06 16:31:02 UTC (rev 56154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4191,7 +4191,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @expectedDeprecated wp_get_loading_attr_default
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @dataProvider data_special_contexts_for_the_content
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @dataProvider data_special_contexts_for_the_content_wp_get_loading_attr_default
</ins><span class="cx" style="display: block; padding: 0 10px">          *
</span><span class="cx" style="display: block; padding: 0 10px">         * @param string $context Context for the element for which the `loading` attribute value is requested.
</span><span class="cx" style="display: block; padding: 0 10px">         */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4208,7 +4208,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @expectedDeprecated wp_get_loading_attr_default
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @dataProvider data_special_contexts_for_the_content
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @dataProvider data_special_contexts_for_the_content_wp_get_loading_attr_default
</ins><span class="cx" style="display: block; padding: 0 10px">          *
</span><span class="cx" style="display: block; padding: 0 10px">         * @param string $context Context for the element for which the `loading` attribute value is requested.
</span><span class="cx" style="display: block; padding: 0 10px">         */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4234,6 +4234,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">         */
</span><span class="cx" style="display: block; padding: 0 10px">        public function data_special_contexts_for_the_content() {
</span><span class="cx" style="display: block; padding: 0 10px">                return array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                        'widget_media_image'      => array( 'context' => 'widget_media_image' ),
</ins><span class="cx" style="display: block; padding: 0 10px">                         'the_post_thumbnail'      => array( 'context' => 'the_post_thumbnail' ),
</span><span class="cx" style="display: block; padding: 0 10px">                        'wp_get_attachment_image' => array( 'context' => 'wp_get_attachment_image' ),
</span><span class="cx" style="display: block; padding: 0 10px">                );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4240,6 +4241,18 @@
</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">+         * Data provider.
+        *
+        * @return array[]
+        */
+       public function data_special_contexts_for_the_content_wp_get_loading_attr_default() {
+               return array(
+                       'the_post_thumbnail'      => array( 'context' => 'the_post_thumbnail' ),
+                       'wp_get_attachment_image' => array( 'context' => 'wp_get_attachment_image' ),
+               );
+       }
+
+       /**
</ins><span class="cx" style="display: block; padding: 0 10px">          * Tests that wp_get_loading_attr_default() returns the expected loading attribute value.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @ticket 53675
</span></span></pre></div>
<a id="trunktestsphpunittestswidgetswpWidgetMediaImagephp"></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/wpWidgetMediaImage.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/widgets/wpWidgetMediaImage.php  2023-07-06 14:15:00 UTC (rev 56153)
+++ trunk/tests/phpunit/tests/widgets/wpWidgetMediaImage.php    2023-07-06 16:31:02 UTC (rev 56154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -494,6 +494,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                // Custom image class.
</span><span class="cx" style="display: block; padding: 0 10px">                $this->assertStringContainsString( 'src="http://example.org/url/to/image.jpg"', $output );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                $this->assertStringContainsString( 'decoding="async"', $output );
+               $this->assertStringContainsString( 'loading="lazy"', $output );
</ins><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                // Link settings.
</span><span class="cx" style="display: block; padding: 0 10px">                ob_start();
</span></span></pre>
</div>
</div>

</body>
</html>