<!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>[48272] trunk: Media: Improve support for opting out of lazy-loading for template images.</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/48272">48272</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/48272","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>2020-07-02 02:01:28 +0000 (Thu, 02 Jul 2020)</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: Improve support for opting out of lazy-loading for template images.
With this changeset, in addition to the already present `wp_lazy_loading_enabled` filter, developers can now opt out of lazy-loading template images via `wp_get_attachment_image()` by passing a `loading` attribute with boolean value `false`. This can be used e.g. by theme developers on images which are very likely to be in the initial viewport.
This changeset also improves related test coverage.
Props adamsilverstein, azaozz, joemcgill, johnbillion.
See <a href="https://core.trac.wordpress.org/ticket/50425">#50425</a>, <a href="https://core.trac.wordpress.org/ticket/44427">#44427</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 2020-07-01 22:04:25 UTC (rev 48271)
+++ trunk/src/wp-includes/media.php 2020-07-02 02:01:28 UTC (rev 48272)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1048,6 +1048,12 @@
</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">+ // If `loading` attribute default of `lazy` is overridden for this
+ // image to omit the attribute, ensure it is not included.
+ if ( array_key_exists( 'loading', $attr ) && ! $attr['loading'] ) {
+ unset( $attr['loading'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Generate 'srcset' and 'sizes' if not already present.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $attr['srcset'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $image_meta = wp_get_attachment_metadata( $attachment_id );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1725,9 +1731,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $value The `loading` attribute value, defaults to `lazy`.
- * @param string $image The HTML `img` tag to be filtered.
- * @param string $context Additional context about how the function was called or where the img tag is.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|bool $value The `loading` attribute value. Returning a false-y value will result in the
+ * attribute being omitted for the image. Default is `lazy`.
+ * @param string $image The HTML `img` tag to be filtered.
+ * @param string $context Additional context about how the function was called or where the img tag is.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $value = apply_filters( 'wp_img_tag_add_loading_attr', 'lazy', $image, $context );
</span><span class="cx" style="display: block; padding: 0 10px">
</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 2020-07-01 22:04:25 UTC (rev 48271)
+++ trunk/tests/phpunit/tests/media.php 2020-07-02 02:01:28 UTC (rev 48272)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2675,16 +2675,29 @@
</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 44427
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 50367
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_wp_img_tag_add_loading_attr() {
+ $img = '<img src="example.png" alt=" width="300" height="225" />';
+ $img = wp_img_tag_add_loading_attr( $img, 'test' );
+
+ $this->assertContains( ' loading="lazy"', $img );
+ }
+
+ /**
+ * @ticket 44427
+ * @ticket 50367
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_wp_img_tag_add_loading_attr_without_src() {
</span><span class="cx" style="display: block; padding: 0 10px"> $img = '<img alt=" width="300" height="225" />';
</span><span class="cx" style="display: block; padding: 0 10px"> $img = wp_img_tag_add_loading_attr( $img, 'test' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertNotContains( ' loading="lazy"', $img );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertNotContains( ' loading=', $img );
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 44427
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 50367
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_wp_img_tag_add_loading_attr_with_single_quotes() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2691,8 +2704,110 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $img = "<img src='example.png' alt=' width='300' height='225' />";
</span><span class="cx" style="display: block; padding: 0 10px"> $img = wp_img_tag_add_loading_attr( $img, 'test' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertNotContains( ' loading=', $img );
+
+ // Test specifically that the attribute is not there with double-quotes,
+ // to avoid regressions.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotContains( ' loading="lazy"', $img );
</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 44427
+ * @ticket 50425
+ */
+ function test_wp_img_tag_add_loading_attr_opt_out() {
+ $img = '<img src="example.png" alt=" width="300" height="225" />';
+ add_filter( 'wp_img_tag_add_loading_attr', '__return_false' );
+
+ $this->assertNotContains( ' loading=', $img );
+ }
+
+ /**
+ * @ticket 44427
+ * @ticket 50425
+ */
+ function test_wp_get_attachment_image_loading() {
+ $img = wp_get_attachment_image( self::$large_id );
+
+ $this->assertContains( ' loading="lazy"', $img );
+ }
+
+ /**
+ * @ticket 44427
+ * @ticket 50425
+ */
+ function test_wp_get_attachment_image_loading_opt_out() {
+ add_filter( 'wp_lazy_loading_enabled', '__return_false' );
+ $img = wp_get_attachment_image( self::$large_id );
+
+ // There should not be any loading attribute in this case.
+ $this->assertNotContains( ' loading=', $img );
+ }
+
+ /**
+ * @ticket 44427
+ * @ticket 50425
+ */
+ function test_wp_get_attachment_image_loading_opt_out_individual() {
+ // The default is already tested above, the filter below ensures that
+ // lazy-loading is definitely enabled globally for images.
+ add_filter( 'wp_lazy_loading_enabled', '__return_true' );
+
+ $img = wp_get_attachment_image( self::$large_id, 'thumbnail', false, array( 'loading' => false ) );
+
+ // There should not be any loading attribute in this case.
+ $this->assertNotContains( ' loading=', $img );
+ }
+
+ /**
+ * @ticket 44427
+ * @ticket 50425
+ * @dataProvider data_wp_lazy_loading_enabled_tag_name_defaults
+ *
+ * @param string $tag_name Function context.
+ * @param bool $expected Expected return value.
+ */
+ function test_wp_lazy_loading_enabled_tag_name_defaults( $tag_name, $expected ) {
+ if ( $expected ) {
+ $this->assertTrue( wp_lazy_loading_enabled( $tag_name, 'the_content' ) );
+ } else {
+ $this->assertFalse( wp_lazy_loading_enabled( $tag_name, 'the_content' ) );
+ }
+ }
+
+ function data_wp_lazy_loading_enabled_tag_name_defaults() {
+ return array(
+ 'img => true' => array( 'img', true ),
+ 'iframe => false' => array( 'iframe', false ),
+ 'arbitrary tag => false' => array( 'blink', false ),
+ );
+ }
+
+ /**
+ * @ticket 50425
+ * @dataProvider data_wp_lazy_loading_enabled_context_defaults
+ *
+ * @param string $context Function context.
+ * @param bool $expected Expected return value.
+ */
+ function test_wp_lazy_loading_enabled_context_defaults( $context, $expected ) {
+ if ( $expected ) {
+ $this->assertTrue( wp_lazy_loading_enabled( 'img', $context ) );
+ } else {
+ $this->assertFalse( wp_lazy_loading_enabled( 'img', $context ) );
+ }
+ }
+
+ function data_wp_lazy_loading_enabled_context_defaults() {
+ return array(
+ 'wp_get_attachment_image => true' => array( 'wp_get_attachment_image', true ),
+ 'the_content => true' => array( 'the_content', true ),
+ 'the_excerpt => true' => array( 'the_excerpt', true ),
+ 'widget_text_content => true' => array( 'widget_text_content', true ),
+ 'get_avatar => true' => array( 'get_avatar', true ),
+ 'arbitrary context => true' => array( 'something_completely_arbitrary', true ),
+ );
+ }
</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>