<!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>[38826] trunk: Resource Hints: Allow passing custom attributes to resource hints.</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 { 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/38826">38826</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/38826","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-10-19 09:28:22 +0000 (Wed, 19 Oct 2016)</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'>Resource Hints: Allow passing custom attributes to resource hints.
<a href="https://core.trac.wordpress.org/changeset/37920">[37920]</a> introduced resource hints that allow browsers to prefetch specific pages or render them in the background. With this change, the `as`, `crossorigin`, `pr`, and `type` attributes can be passed in addition to the URLs/hosts.
Props peterwilsoncc, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/38121">#38121</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>
<li><a href="#trunktestsphpunittestsgeneralresourceHintsphp">trunk/tests/phpunit/tests/general/resourceHints.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesgeneraltemplatephp"></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/general-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/general-template.php 2016-10-19 08:43:55 UTC (rev 38825)
+++ trunk/src/wp-includes/general-template.php 2016-10-19 09:28:22 UTC (rev 38826)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2830,6 +2830,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $hints['dns-prefetch'][] = apply_filters( 'emoji_svg_url', 'https://s.w.org/images/core/emoji/2.2.1/svg/' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $hints as $relation_type => $urls ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $unique_urls = array();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters domains and URLs for resource hints of relation type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2841,16 +2843,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $urls = apply_filters( 'wp_resource_hints', $urls, $relation_type );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $urls as $key => $url ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $atts = array();
+
+ if ( is_array( $url ) ) {
+ if ( isset( $url['href'] ) ) {
+ $atts = $url;
+ $url = $url['href'];
+ } else {
+ continue;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $url = esc_url( $url, array( 'http', 'https' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $url ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unset( $urls[ $key ] );
</del><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">+ if ( isset( $unique_urls[ $url ] ) ) {
+ continue;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( in_array( $relation_type, array( 'preconnect', 'dns-prefetch' ) ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $parsed = wp_parse_url( $url );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $parsed['host'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unset( $urls[ $key ] );
</del><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">@@ -2862,13 +2879,34 @@
</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">- $urls[ $key ] = $url;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $atts['rel'] = $relation_type;
+ $atts['href'] = $url;
+
+ $unique_urls[ $url ] = $atts;
</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">- $urls = array_unique( $urls );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $unique_urls as $atts ) {
+ $html = '';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $urls as $url ) {
- printf( "<link rel='%s' href='%s' />\n", $relation_type, $url );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $atts as $attr => $value ) {
+ if ( ! is_scalar( $value ) ||
+ ( ! in_array( $attr, array( 'as', 'crossorigin', 'href', 'pr', 'rel', 'type' ), true ) && ! is_numeric( $attr ))
+ ) {
+ continue;
+ }
+
+ $value = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value );
+
+ if ( ! is_string( $attr ) ) {
+ $html .= " $value";
+ } else {
+ $html .= " $attr='$value'";
+ }
+ }
+
+ $html = trim( $html );
+
+ echo "<link $html />\n";
</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="trunktestsphpunittestsgeneralresourceHintsphp"></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/general/resourceHints.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/general/resourceHints.php 2016-10-19 08:43:55 UTC (rev 38825)
+++ trunk/tests/phpunit/tests/general/resourceHints.php 2016-10-19 09:28:22 UTC (rev 38826)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,7 +1,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</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">- * @group template
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group template
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 34292
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_WP_Resource_Hints extends WP_UnitTestCase {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -242,4 +242,59 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $hints;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @group 38121
+ */
+ function test_custom_attributes() {
+ $expected = "<link rel='dns-prefetch' href='//s.w.org' />\n" .
+ "<link rel='preconnect' href='https://make.wordpress.org' />\n" .
+ "<link crossorigin as='image' pr='0.5' href='https://example.com/foo.jpeg' rel='prefetch' />\n" .
+ "<link crossorigin='use-credentials' as='style' href='https://example.com/foo.css' rel='prefetch' />\n" .
+ "<link href='http://wordpress.org' rel='prerender' />\n";
+
+ add_filter( 'wp_resource_hints', array( $this, '_add_url_with_attributes' ), 10, 2 );
+
+ $actual = get_echo( 'wp_resource_hints' );
+
+ remove_filter( 'wp_resource_hints', array( $this, '_add_url_with_attributes' ) );
+
+ $this->assertEquals( $expected, $actual );
+ }
+
+ function _add_url_with_attributes( $hints, $method ) {
+ // Ignore hints with missing href attributes.
+ $hints[] = array(
+ 'rel' => 'foo',
+ );
+
+ if ( 'preconnect' === $method ) {
+ // Should ignore rel attributes.
+ $hints[] = array(
+ 'rel' => 'foo',
+ 'href' => 'https://make.wordpress.org/great-again',
+ );
+ } elseif ( 'prefetch' === $method ) {
+ $hints[] = array(
+ 'crossorigin',
+ 'as' => 'image',
+ 'pr' => 0.5,
+ 'href' => 'https://example.com/foo.jpeg',
+ );
+ $hints[] = array(
+ 'crossorigin' => 'use-credentials',
+ 'as' => 'style',
+ 'href' => 'https://example.com/foo.css',
+ );
+ } elseif ( 'prerender' === $method ) {
+ // Ignore invalid attributes.
+ $hints[] = array(
+ 'foo' => 'bar',
+ 'bar' => 'baz',
+ 'href' => 'http://wordpress.org',
+ );
+ }
+
+ return $hints;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>