<!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>[53149] trunk: Media: Run the `wp_content_img_tag` filter once per 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/53149">53149</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/53149","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-04-12 05:16:46 +0000 (Tue, 12 Apr 2022)</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: Run the `wp_content_img_tag` filter once per image.
Prevent multiple identical `img` tags in a block of content causing the `wp_content_img_tag` filter to fire multiple times for that image.
Follow up to <a href="https://core.trac.wordpress.org/changeset/53028">[53028]</a>.
Props superpoincare, flixos90, pbearne, peterwilsoncc.
Fixes <a href="https://core.trac.wordpress.org/ticket/55510">#55510</a>.
See <a href="https://core.trac.wordpress.org/ticket/55347">#55347</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 2022-04-12 01:45:18 UTC (rev 53148)
+++ trunk/src/wp-includes/media.php 2022-04-12 05:16:46 UTC (rev 53149)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1857,6 +1857,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $filtered_image !== $match[0] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( $match[0], $filtered_image, $content );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /*
+ * Unset image lookup to not run the same logic again unnecessarily if the same image tag is used more than
+ * once in the same blob of content.
+ */
+ unset( $images[ $match[0] ] );
</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"> // Filter an iframe match.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1871,6 +1877,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $filtered_iframe !== $match[0] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( $match[0], $filtered_iframe, $content );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /*
+ * Unset iframe lookup to not run the same logic again unnecessarily if the same iframe tag is used more
+ * than once in the same blob of content.
+ */
+ unset( $iframes[ $match[0] ] );
</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>
<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 2022-04-12 01:45:18 UTC (rev 53148)
+++ trunk/tests/phpunit/tests/media.php 2022-04-12 05:16:46 UTC (rev 53149)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2304,7 +2304,74 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_filter_content_tags( $img_tag_1 );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 1, $filter->get_call_count() );
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 55510
+ * @covers ::wp_filter_content_tags
+ */
+ public function test_wp_filter_content_tags_handles_duplicate_img_and_iframe_tags_once() {
+ $img = get_image_tag( self::$large_id, '', '', '', 'large' );
+ $iframe = '<iframe src="https://www.example.com" width="640" height="360"></iframe>';
+ $content = "$img\n$img\n$iframe\n$iframe";
+
+ // Record how often one of the available img and iframe filters is run.
+ // Both images and iframes support lazy-loading, so that's why this is used here.
+ $img_filter = new MockAction();
+ add_filter( 'wp_img_tag_add_loading_attr', array( &$img_filter, 'filter' ) );
+ $iframe_filter = new MockAction();
+ add_filter( 'wp_iframe_tag_add_loading_attr', array( &$iframe_filter, 'filter' ) );
+
+ // Ensure the img and iframe filters only ran once because the content is a single duplicated img tag and a
+ // single duplicate iframe tag.
+ wp_filter_content_tags( $content );
+ $this->assertSame( 1, $img_filter->get_call_count() );
+ $this->assertSame( 1, $iframe_filter->get_call_count() );
+ }
+
+ /**
+ * @ticket 55510
+ * @covers ::wp_filter_content_tags
+ */
+ public function test_wp_filter_content_tags_filter_with_identical_image_tags_custom_attributes() {
+ $img = get_image_tag( self::$large_id, '', '', '', 'large' );
+ $img = str_replace( '<img ', '<img srcset="custom" sizes="custom" loading="custom" ', $img );
+ $content = "$img\n$img";
+
+ add_filter(
+ 'wp_content_img_tag',
+ function( $filtered_image ) {
+ return "<span>$filtered_image</span>";
+ }
+ );
+
+ // Ensure there is no duplicate <span> wrapping the image.
+ $this->assertStringNotContainsString( '<span><span><img ', wp_filter_content_tags( $content ) );
+ }
+
+ /**
+ * @ticket 55510
+ * @covers ::wp_filter_content_tags
+ */
+ public function test_wp_filter_content_tags_filter_with_identical_image_tags_disabled_core_filters() {
+ $img = get_image_tag( self::$large_id, '', '', '', 'large' );
+ $content = "$img\n$img";
+
+ add_filter( 'wp_img_tag_add_loading_attr', '__return_false' );
+ add_filter( 'wp_img_tag_add_width_and_height_attr', '__return_false' );
+ add_filter( 'wp_img_tag_add_srcset_and_sizes_attr', '__return_false' );
+
+ add_filter(
+ 'wp_content_img_tag',
+ function( $filtered_image ) {
+ return "<span>$filtered_image</span>";
+ }
+ );
+
+ // Ensure the output has both instances of the image wrapped with a single <span>.
+ $this->assertSame( "<span>$img</span>\n<span>$img</span>", wp_filter_content_tags( $content ) );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 33641
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 34528
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>