<!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>[48170] trunk: Media: Ensure images have dimensions to reduce layout shift and facilitate lazy-loading.</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/48170">48170</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/48170","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-06-25 18:43:25 +0000 (Thu, 25 Jun 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: Ensure images have dimensions to reduce layout shift and facilitate lazy-loading.
This changeset ensures that attachment images which are inserted without `width` and `height` attributes still receive them in the frontend, to reduce cumulative layout shift. Adding the dimensions happens as part of the logic for adding `srcset` and `sizes` attributes, which already assume the specific width and height of the respective image.
Images are now only lazy-loaded if they have `width` and `height` attributes present. While missing these attributes itself is what causes layout shifts, lazy-loading such images can make this problem more apparent to the user.
Props adamsilverstein, westonruter.
Fixes <a href="https://core.trac.wordpress.org/ticket/50367">#50367</a>. See <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-06-25 17:39:44 UTC (rev 48169)
+++ trunk/src/wp-includes/media.php 2020-06-25 18:43:25 UTC (rev 48170)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1495,6 +1495,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Adds 'srcset' and 'sizes' attributes to an existing 'img' element.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.5.0 `width` and `height` are now added if not already present.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see wp_calculate_image_srcset()
</span><span class="cx" style="display: block; padding: 0 10px"> * @see wp_calculate_image_sizes()
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1525,6 +1526,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $image;
</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">+ $attr = '';
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $width = preg_match( '/ width="([0-9]+)"/', $image, $match_width ) ? (int) $match_width[1] : 0;
</span><span class="cx" style="display: block; padding: 0 10px"> $height = preg_match( '/ height="([0-9]+)"/', $image, $match_height ) ? (int) $match_height[1] : 0;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1547,10 +1550,13 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- }
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $width || ! $height ) {
- return $image;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $width || ! $height ) {
+ return $image;
+ }
+
+ // Add width and height if not present.
+ $attr .= ' ' . trim( image_hwstring( $width, $height ) );
</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"> $size_array = array( $width, $height );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1567,17 +1573,19 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $srcset && $sizes ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Format the 'srcset' and 'sizes' string and escape attributes.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $attr = sprintf( ' srcset="%s"', esc_attr( $srcset ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attr .= sprintf( ' srcset="%s"', esc_attr( $srcset ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_string( $sizes ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $attr .= sprintf( ' sizes="%s"', esc_attr( $sizes ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</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 'srcset' and 'sizes' attributes to the image markup.
- $image = preg_replace( '/<img ([^>]+?)[\/ ]*>/', '<img $1' . $attr . ' />', $image );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $attr ) ) {
+ return $image;
</ins><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">- return $image;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Add extra attributes to the image markup.
+ return preg_replace( '/<img ([^>]+?)[\/ ]*>/', '<img $1' . $attr . ' />', $image );
</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">@@ -1714,6 +1722,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $value = 'lazy';
</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">+ // Images should have dimension attributes for the `loading` attribute
+ // to be added.
+ if ( false === strpos( $image, ' width=' ) || false === strpos( $image, ' height=' ) ) {
+ return $image;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $quote = null;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Check if the img tag is valid (has `src` attribute) and get the quote character.
</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-06-25 17:39:44 UTC (rev 48169)
+++ trunk/tests/phpunit/tests/media.php 2020-06-25 18:43:25 UTC (rev 48170)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1963,6 +1963,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"> * @ticket 33641
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 50367
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_wp_filter_content_tags() {
</span><span class="cx" style="display: block; padding: 0 10px"> $image_meta = wp_get_attachment_metadata( self::$large_id );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1982,10 +1983,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $img_xhtml = str_replace( ' />', '/>', $img );
</span><span class="cx" style="display: block; padding: 0 10px"> $img_html5 = str_replace( ' />', '>', $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">+ $hwstring = image_hwstring( $size_array[0], $size_array[1] );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Manually add srcset and sizes to the markup from get_image_tag().
</span><span class="cx" style="display: block; padding: 0 10px"> $respimg = preg_replace( '|<img ([^>]+) />|', '<img $1 ' . $srcset . ' ' . $sizes . ' />', $img );
</span><span class="cx" style="display: block; padding: 0 10px"> $respimg_no_size_in_class = preg_replace( '|<img ([^>]+) />|', '<img $1 ' . $srcset . ' ' . $sizes . ' />', $img_no_size_in_class );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $respimg_no_width_height = preg_replace( '|<img ([^>]+) />|', '<img $1 ' . $srcset . ' ' . $sizes . ' />', $img_no_width_height );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $respimg_no_width_height = preg_replace( '|<img ([^>]+) />|', '<img $1 ' . $hwstring . $srcset . ' ' . $sizes . ' />', $img_no_width_height );
</ins><span class="cx" style="display: block; padding: 0 10px"> $respimg_with_sizes_attr = preg_replace( '|<img ([^>]+) />|', '<img $1 ' . $srcset . ' />', $img_with_sizes_attr );
</span><span class="cx" style="display: block; padding: 0 10px"> $respimg_xhtml = preg_replace( '|<img ([^>]+)/>|', '<img $1 ' . $srcset . ' ' . $sizes . ' />', $img_xhtml );
</span><span class="cx" style="display: block; padding: 0 10px"> $respimg_html5 = preg_replace( '|<img ([^>]+)>|', '<img $1 ' . $srcset . ' ' . $sizes . ' />', $img_html5 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1997,7 +2000,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <p>Image, no size class. Should have srcset and sizes.</p>
</span><span class="cx" style="display: block; padding: 0 10px"> %2$s
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <p>Image, no width and height attributes. Should have srcset and sizes (from matching the file name).</p>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <p>Image, no width and height attributes. Should have width, height, srcset and sizes (from matching the file name).</p>
</ins><span class="cx" style="display: block; padding: 0 10px"> %3$s
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <p>Image, no attachment ID class. Should NOT have srcset and sizes.</p>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2530,13 +2533,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"> * @ticket 44427
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 50367
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_wp_lazy_load_content_media() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $img = get_image_tag( self::$large_id, '', '', '', 'medium' );
- $img_xhtml = str_replace( ' />', '/>', $img );
- $img_html5 = str_replace( ' />', '>', $img );
- $iframe = '<iframe src="https://www.example.com"></iframe>';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $image_meta = wp_get_attachment_metadata( self::$large_id );
+ $size_array = $this->_get_image_size_array_from_meta( $image_meta, 'medium' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $img = get_image_tag( self::$large_id, '', '', '', 'medium' );
+ $img_xhtml = str_replace( ' />', '/>', $img );
+ $img_html5 = str_replace( ' />', '>', $img );
+ $img_no_width_height = str_replace( ' width="' . $size_array[0] . '"', '', $img );
+ $img_no_width_height = str_replace( ' height="' . $size_array[1] . '"', '', $img_no_width_height );
+ $iframe = '<iframe src="https://www.example.com"></iframe>';
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $lazy_img = wp_img_tag_add_loading_attr( $img, 'test' );
</span><span class="cx" style="display: block; padding: 0 10px"> $lazy_img_xhtml = wp_img_tag_add_loading_attr( $img_xhtml, 'test' );
</span><span class="cx" style="display: block; padding: 0 10px"> $lazy_img_html5 = wp_img_tag_add_loading_attr( $img_html5, 'test' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2551,13 +2560,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> %2$s
</span><span class="cx" style="display: block; padding: 0 10px"> <p>Image, HTML 5.0 style.</p>
</span><span class="cx" style="display: block; padding: 0 10px"> %3$s
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <p>Image, with pre-existing "loading" attribute.</p>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <p>Image, with pre-existing "loading" attribute. Should not be modified.</p>
+ %4$s
+ <p>Image, without dimension attributes. Should not be modified.</p>
</ins><span class="cx" style="display: block; padding: 0 10px"> %5$s
</span><span class="cx" style="display: block; padding: 0 10px"> <p>Iframe, standard. Should not be modified.</p>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- %4$s';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ %6$s';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $content_unfiltered = sprintf( $content, $img, $img_xhtml, $img_html5, $iframe, $img_eager );
- $content_filtered = sprintf( $content, $lazy_img, $lazy_img_xhtml, $lazy_img_html5, $iframe, $img_eager );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $content_unfiltered = sprintf( $content, $img, $img_xhtml, $img_html5, $img_eager, $img_no_width_height, $iframe );
+ $content_filtered = sprintf( $content, $lazy_img, $lazy_img_xhtml, $lazy_img_html5, $img_eager, $img_no_width_height, $iframe );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Do not add srcset and sizes.
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_img_tag_add_srcset_and_sizes_attr', '__return_false' );
</span></span></pre>
</div>
</div>
</body>
</html>