<!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>[56651] trunk: Media: Introduce filters to customize the results from `wp_get_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/56651">56651</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/56651","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-09-21 16:35:30 +0000 (Thu, 21 Sep 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: Introduce filters to customize the results from `wp_get_loading_optimization_attributes()`.
This changeset introduces two filters that allow customizing the loading optimization attributes array returned from `wp_get_loading_optimization_attributes()` for individual HTML tags:
* The `wp_get_loading_optimization_attributes` filter can be used to modify the results from the WordPress core logic.
* The `pre_wp_get_loading_optimization_attributes` filter can be used to use entirely custom logic and effectively short-circuit the core function.
Props pereirinha, mukesh27, spacedmonkey, joemcgill.
Fixes <a href="https://core.trac.wordpress.org/ticket/58893">#58893</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-09-21 16:34:59 UTC (rev 56650)
+++ trunk/src/wp-includes/media.php 2023-09-21 16:35:30 UTC (rev 56651)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5625,6 +5625,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_get_loading_optimization_attributes( $tag_name, $attr, $context ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_query;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters whether to short-circuit loading optimization attributes.
+ *
+ * Returning an array from the filter will effectively short-circuit the loading of optimization attributes,
+ * returning that value instead.
+ *
+ * @since 6.4.0
+ *
+ * @param array|false $loading_attrs False by default, or array of loading optimization attributes to short-circuit.
+ * @param string $tag_name The tag name.
+ * @param array $attr Array of the attributes for the tag.
+ * @param string $context Context for the element for which the loading optimization attribute is requested.
+ */
+ $loading_attrs = apply_filters( 'pre_wp_get_loading_optimization_attributes', false, $tag_name, $attr, $context );
+
+ if ( is_array( $loading_attrs ) ) {
+ return $loading_attrs;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $loading_attrs = array();
</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">@@ -5632,17 +5651,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The skip is also applicable for `fetchpriority`.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'template' === $context ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $loading_attrs;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/media.php */
+ return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context );
</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"> // For now this function only supports images and iframes.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'img' !== $tag_name && 'iframe' !== $tag_name ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $loading_attrs;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/media.php */
+ return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context );
</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"> // For any resources, width and height must be provided, to avoid layout shifts.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $attr['width'], $attr['height'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $loading_attrs;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/media.php */
+ return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context );
</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">@@ -5654,7 +5676,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> // TODO: Handle shortcode images together with the content (see https://core.trac.wordpress.org/ticket/58853).
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'the_content' !== $context && 'do_shortcode' !== $context && doing_filter( 'the_content' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $loading_attrs;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** This filter is documented in wp-includes/media.php */
+ return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context );
</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">@@ -5789,7 +5812,17 @@
</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">- return $loading_attrs;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the loading optimization attributes.
+ *
+ * @since 6.4.0
+ *
+ * @param array $loading_attrs The loading optimization attributes.
+ * @param string $tag_name The tag name.
+ * @param array $attr Array of the attributes for the tag.
+ * @param string $context Context for the element for which the loading optimization attribute is requested.
+ */
+ return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context );
</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 2023-09-21 16:34:59 UTC (rev 56650)
+++ trunk/tests/phpunit/tests/media.php 2023-09-21 16:35:30 UTC (rev 56651)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5441,6 +5441,109 @@
</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">+ * Tests for pre_wp_get_loading_optimization_attributes filter.
+ *
+ * @ticket 58893
+ */
+ public function test_pre_wp_get_loading_optimization_attributes_filter() {
+ add_filter(
+ 'pre_wp_get_loading_optimization_attributes',
+ static function ( $loading_attrs ) {
+ if ( false === $loading_attrs ) {
+ // Initialize as an empty array.
+ $loading_attrs = array();
+ }
+ $loading_attrs['fetchpriority'] = 'high';
+
+ return $loading_attrs;
+ },
+ 10,
+ 1
+ );
+
+ $attr = $this->get_width_height_for_high_priority();
+
+ $this->assertSame(
+ array( 'fetchpriority' => 'high' ),
+ wp_get_loading_optimization_attributes( 'img', $attr, 'the_content' ),
+ 'The filter did not return early fetchpriority attribute'
+ );
+
+ // Clean up the filter.
+ add_filter( 'pre_wp_get_loading_optimization_attributes', '__return_false' );
+
+ $this->assertSameSets(
+ array( 'loading' => 'lazy' ),
+ wp_get_loading_optimization_attributes( 'img', $attr, 'the_content' ),
+ 'The filter did not return the default attributes.'
+ );
+
+ // Return no loading attributes.
+ add_filter( 'pre_wp_get_loading_optimization_attributes', '__return_empty_array' );
+
+ $this->assertSameSets(
+ array(),
+ wp_get_loading_optimization_attributes( 'img', $attr, 'the_content' ),
+ 'The filter did not clean up all attributes.'
+ );
+
+ // Modify the loading attributes with any custom attributes.
+ add_filter(
+ 'pre_wp_get_loading_optimization_attributes',
+ static function ( $loading_attrs ) {
+ if ( false === $loading_attrs ) {
+ // Initialize as an empty array.
+ $loading_attrs = array();
+ }
+ $loading_attrs['custom_attr'] = 'custom_value';
+
+ return $loading_attrs;
+ },
+ 10,
+ 1
+ );
+
+ $this->assertSameSets(
+ array( 'custom_attr' => 'custom_value' ),
+ wp_get_loading_optimization_attributes( 'img', $attr, 'the_content' ),
+ 'The filter did not return custom attributes.'
+ );
+ }
+
+ /**
+ * Tests for wp_get_loading_optimization_attributes filter.
+ *
+ * @ticket 58893
+ */
+ public function test_wp_get_loading_optimization_attributes_filter() {
+ $attr = $this->get_width_height_for_high_priority();
+
+ $this->assertSameSets(
+ array( 'loading' => 'lazy' ),
+ wp_get_loading_optimization_attributes( 'img', $attr, 'the_content' ),
+ 'Before the filter it will not return the loading attribute.'
+ );
+
+ add_filter(
+ 'wp_get_loading_optimization_attributes',
+ static function ( $loading_attrs ) {
+ unset( $loading_attrs['loading'] );
+ $loading_attrs['fetchpriority'] = 'high';
+
+ return $loading_attrs;
+ },
+ 10,
+ 1
+ );
+
+ $this->assertSameSets(
+ array( 'fetchpriority' => 'high' ),
+ wp_get_loading_optimization_attributes( 'img', $attr, 'the_content' ),
+ 'After the filter it will not return the fetchpriority attribute.'
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Helper method to keep track of the last context returned by the 'wp_get_attachment_image_context' filter.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The method parameter is passed by reference and therefore will always contain the last context value.
</span></span></pre>
</div>
</div>
</body>
</html>