<!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>[55816] trunk: Media: Increase default for `wp_omit_loading_attr_threshold` to 3.</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/55816">55816</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/55816","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-05-16 18:50:11 +0000 (Tue, 16 May 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: Increase default for `wp_omit_loading_attr_threshold` to 3.
The previous default threshold for how many content images to skip lazy-loading on (which was just 1) has proven to be too strict: HTTP Archive data shows that >70% of sites have up to 3 equal-sized images in the initial viewport, each of which could be the LCP image and therefore should not be lazy-loaded. Lazy-loading too many images has adverse effects on load time performance, while increasing the default threshold will not negatively affect load time performance even for sites where a threshold of 1 would be the perfect choice.
The change of default value in this changeset will improve performance for more WordPress sites out of the box. The `wp_omit_loading_attr_threshold` filter can still be used to customize and fine tune the value where needed.
Props thekt12, spacedmonkey, westonruter, flixos90.
Fixes <a href="https://core.trac.wordpress.org/ticket/58213">#58213</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-05-16 18:38:52 UTC (rev 55815)
+++ trunk/src/wp-includes/media.php 2023-05-16 18:50:11 UTC (rev 55816)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5435,7 +5435,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Under the hood, the function uses {@see wp_increase_content_media_count()} every time it is called for an element
</span><span class="cx" style="display: block; padding: 0 10px"> * within the main content. If the element is the very first content element, the `loading` attribute will be omitted.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This default threshold of 1 content element to omit the `loading` attribute for can be customized using the
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This default threshold of 3 content elements to omit the `loading` attribute for can be customized using the
</ins><span class="cx" style="display: block; padding: 0 10px"> * {@see 'wp_omit_loading_attr_threshold'} filter.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5485,7 +5485,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Gets the threshold for how many of the first content media elements to not lazy-load.
</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 function runs the {@see 'wp_omit_loading_attr_threshold'} filter, which uses a default threshold value of 1.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This function runs the {@see 'wp_omit_loading_attr_threshold'} filter, which uses a default threshold value of 3.
</ins><span class="cx" style="display: block; padding: 0 10px"> * The filter is only run once per page load, unless the `$force` parameter is used.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5506,10 +5506,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * for only the very first content media element.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.3.0 The default threshold was changed from 1 to 3.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $omit_threshold The number of media elements where the `loading` attribute will not be added. Default 1.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $omit_threshold The number of media elements where the `loading` attribute will not be added. Default 3.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $omit_threshold = apply_filters( 'wp_omit_loading_attr_threshold', 1 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $omit_threshold = apply_filters( 'wp_omit_loading_attr_threshold', 3 );
</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"> return $omit_threshold;
</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-05-16 18:38:52 UTC (rev 55815)
+++ trunk/tests/phpunit/tests/media.php 2023-05-16 18:50:11 UTC (rev 55816)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3585,8 +3585,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // and in the main query, and do not increase the content media count.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'lazy', wp_get_loading_attr_default( 'wp_get_attachment_image' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Return `false` if in the loop and in the main query and it is the first element.
- $this->assertFalse( wp_get_loading_attr_default( $context ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Return `false` in the main query for first three element.
+ $this->assertFalse( wp_get_loading_attr_default( $context ), 'Expected first image to not be lazy-loaded.' );
+ $this->assertFalse( wp_get_loading_attr_default( $context ), 'Expected second image to not be lazy-loaded.' );
+ $this->assertFalse( wp_get_loading_attr_default( $context ), 'Expected third image to not be lazy-loaded.' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Return 'lazy' if in the loop and in the main query for any subsequent elements.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'lazy', wp_get_loading_attr_default( $context ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3618,19 +3620,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->reset_content_media_count();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->reset_omit_loading_attr_filter();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Use the filter to alter the threshold for not lazy-loading to the first three elements.
- add_filter(
- 'wp_omit_loading_attr_threshold',
- function() {
- return 3;
- }
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Use the filter to alter the threshold for not lazy-loading to the first five elements.
+ $this->force_omit_loading_attr_threshold( 5 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> while ( have_posts() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> the_post();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Due to the filter, now the first three elements should not be lazy-loaded, i.e. return `false`.
- for ( $i = 0; $i < 3; $i++ ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Due to the filter, now the first five elements should not be lazy-loaded, i.e. return `false`.
+ for ( $i = 0; $i < 5; $i++ ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( wp_get_loading_attr_default( 'the_content' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3655,12 +3652,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $lazy_iframe2 = wp_iframe_tag_add_loading_attr( $iframe2, 'the_content' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Use a threshold of 2.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter(
- 'wp_omit_loading_attr_threshold',
- function() {
- return 2;
- }
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->force_omit_loading_attr_threshold( 2 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Following the threshold of 2, the first two content media elements should not be lazy-loaded.
</span><span class="cx" style="display: block; padding: 0 10px"> $content_unfiltered = $img1 . $iframe1 . $img2 . $img3 . $iframe2;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3690,24 +3682,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_wp_omit_loading_attr_threshold() {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->reset_omit_loading_attr_filter();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Apply filter, ensure default value of 1.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Apply filter, ensure default value of 3.
</ins><span class="cx" style="display: block; padding: 0 10px"> $omit_threshold = wp_omit_loading_attr_threshold();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 1, $omit_threshold );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 3, $omit_threshold );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Add a filter that changes the value to 3. However, the filter is not applied a subsequent time in a single
- // page load by default, so the value is still 1.
- add_filter(
- 'wp_omit_loading_attr_threshold',
- function() {
- return 3;
- }
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Add a filter that changes the value to 1. However, the filter is not applied a subsequent time in a single
+ // page load by default, so the value is still 3.
+ $this->force_omit_loading_attr_threshold( 1 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $omit_threshold = wp_omit_loading_attr_threshold();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 1, $omit_threshold );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 3, $omit_threshold );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Only by enforcing a fresh check, the filter gets re-applied.
</span><span class="cx" style="display: block; padding: 0 10px"> $omit_threshold = wp_omit_loading_attr_threshold( true );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 3, $omit_threshold );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 1, $omit_threshold );
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3725,6 +3713,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Do not add srcset, sizes, or decoding attributes as they are irrelevant for this test.
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_img_tag_add_srcset_and_sizes_attr', '__return_false' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_img_tag_add_decoding_attr', '__return_false' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->force_omit_loading_attr_threshold( 1 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $img1 = get_image_tag( self::$large_id, '', '', '', 'large' );
</span><span class="cx" style="display: block; padding: 0 10px"> $img2 = get_image_tag( self::$large_id, '', '', '', 'medium' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3777,6 +3766,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $attr;
</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">+ $this->force_omit_loading_attr_threshold( 1 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $content_img = get_image_tag( self::$large_id, '', '', '', 'large' );
</span><span class="cx" style="display: block; padding: 0 10px"> $lazy_content_img = wp_img_tag_add_loading_attr( $content_img, 'the_content' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4012,6 +4002,19 @@
</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">+ /**
+ * Change the omit loading attribute threshold value.
+ *
+ * @param int $threshold Threshold value to change.
+ */
+ public function force_omit_loading_attr_threshold( $threshold ) {
+ add_filter(
+ 'wp_omit_loading_attr_threshold',
+ static function() use ( $threshold ) {
+ return $threshold;
+ }
+ );
+ }
</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>