<!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>[37920] trunk: Script Loader: Introduce an API to register 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/37920">37920</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/37920","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ocean90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-06-29 19:35:27 +0000 (Wed, 29 Jun 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'>Script Loader: Introduce an API to register resource hints.
Resource hints allow browsers to prefetch specific pages or render them in the background to perform DNS lookups or to begin the connection handshake (DNS, TCP, TLS) in the background.
By default, `wp_resource_hints()` prints hints for "s.w.org" (the WordPress.org CDN) and for all scripts and styles which are enqueued from external hosts.
Use the `wp_resource_hints` filter to add custom domains and URLs for `dns-prefetch`, `preconnect`, `prefetch` or `prerender`.
Props voldemortensen, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/34292">#34292</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesadminfiltersphp">trunk/src/wp-admin/includes/admin-filters.php</a></li>
<li><a href="#trunksrcwpincludesdefaultfiltersphp">trunk/src/wp-includes/default-filters.php</a></li>
<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsgeneralresourceHintsphp">trunk/tests/phpunit/tests/general/resourceHints.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesadminfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/admin-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/admin-filters.php 2016-06-29 19:34:04 UTC (rev 37919)
+++ trunk/src/wp-admin/includes/admin-filters.php 2016-06-29 19:35:27 UTC (rev 37920)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -43,6 +43,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'admin_head', 'wp_site_icon' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'admin_head', '_ipad_meta' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Prerendering.
+add_filter( 'admin_head', 'wp_resource_hints' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'admin_print_scripts-post.php', 'wp_page_reload_on_back_button_js' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'admin_print_scripts-post-new.php', 'wp_page_reload_on_back_button_js' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesdefaultfiltersphp"></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/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/default-filters.php 2016-06-29 19:34:04 UTC (rev 37919)
+++ trunk/src/wp-includes/default-filters.php 2016-06-29 19:35:27 UTC (rev 37920)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -239,6 +239,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_head', 'wp_print_head_scripts', 9 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_head', 'wp_generator' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_head', 'rel_canonical' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_action( 'wp_head', 'wp_resource_hints' );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_head', 'wp_shortlink_wp_head', 10, 0 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_head', 'wp_site_icon', 99 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_footer', 'wp_print_footer_scripts', 20 );
</span></span></pre></div>
<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-06-29 19:34:04 UTC (rev 37919)
+++ trunk/src/wp-includes/general-template.php 2016-06-29 19:35:27 UTC (rev 37920)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2788,6 +2788,97 @@
</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">+ * Prints resource hints to browsers for pre-fetching, pre-rendering and pre-connecting to web sites.
+ *
+ * Gives hints to browsers to prefetch specific pages or render them in the background,
+ * to perform DNS lookups or to begin the connection handshake (DNS, TCP, TLS) in the background.
+ *
+ * These performance improving indicators work by using `<link rel"…">`.
+ *
+ * @since 4.6.0
+ */
+function wp_resource_hints() {
+ $hints = array(
+ 'dns-prefetch' => wp_resource_hints_scripts_styles(),
+ 'preconnect' => array( 's.w.org' ),
+ 'prefetch' => array(),
+ 'prerender' => array(),
+ );
+
+ foreach ( $hints as $relation_type => $urls ) {
+ /**
+ * Filters domains and URLs for resource hints.
+ *
+ * @since 4.6.0
+ *
+ * @param array $urls URLs to print for resource hints.
+ * @param string $relation_type The relation type the URLs are printed for, e.g. 'preconnect' or 'prerender'.
+ */
+ $urls = apply_filters( 'wp_resource_hints', $urls, $relation_type );
+ $urls = array_unique( $urls );
+
+ foreach ( $urls as $url ) {
+ $url = esc_url( $url, array( 'http', 'https' ) );
+
+ if ( in_array( $relation_type, array( 'preconnect', 'dns-prefetch' ) ) ) {
+ $parsed = parse_url( $url );
+
+ if ( ! empty( $parsed['scheme'] ) ) {
+ $url = $parsed['scheme'] . '://' . $parsed['host'];
+ } else {
+ $url = $parsed['host'];
+ }
+ }
+
+ printf( "<link rel='%s' href='%s'>\r\n", $relation_type, $url );
+ }
+ }
+}
+
+/**
+ * Adds dns-prefetch for all scripts and styles enqueued from external hosts.
+ *
+ * @since 4.6.0
+ */
+function wp_resource_hints_scripts_styles() {
+ global $wp_scripts, $wp_styles;
+
+ $unique_hosts = array();
+
+ if ( is_object( $wp_scripts ) && ! empty( $wp_scripts->registered ) ) {
+ foreach ( $wp_scripts->registered as $registered_script ) {
+ $src = $registered_script->src;
+ // Make sure the URL has a scheme, otherwise parse_url() could fail to pass the host.
+ if ( '//' == substr( $src, 0, 2 ) ) {
+ $src = set_url_scheme( $src );
+ }
+
+ $this_host = parse_url( $src, PHP_URL_HOST );
+ if ( ! empty( $this_host ) && ! in_array( $this_host, $unique_hosts ) && $this_host !== $_SERVER['SERVER_NAME'] ) {
+ $unique_hosts[] = $this_host;
+ }
+ }
+ }
+
+ if ( is_object( $wp_styles ) && ! empty( $wp_styles->registered ) ) {
+ foreach ( $wp_styles->registered as $registered_style ) {
+ $src = $registered_style->src;
+ // Make sure the URL has a scheme, otherwise parse_url() could fail to pass the host.
+ if ( '//' == substr( $src, 0, 2 ) ) {
+ $src = set_url_scheme( $src );
+ }
+
+ $this_host = parse_url( $src, PHP_URL_HOST );
+ if ( ! empty( $this_host ) && ! in_array( $this_host, $unique_hosts ) && $this_host !== $_SERVER['SERVER_NAME'] ) {
+ $unique_hosts[] = $this_host;
+ }
+ }
+ }
+
+ return $unique_hosts;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Whether the user should have a WYSIWIG editor.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Checks that the user requires a WYSIWIG editor and that the editor is
</span></span></pre></div>
<a id="trunktestsphpunittestsgeneralresourceHintsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: 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 (rev 0)
+++ trunk/tests/phpunit/tests/general/resourceHints.php 2016-06-29 19:35:27 UTC (rev 37920)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,152 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group template
+ * @ticket 34292
+ */
+class Tests_WP_Resource_Hints extends WP_UnitTestCase {
+ private $old_wp_scripts;
+ private $old_wp_styles;
+
+ function setUp() {
+ parent::setUp();
+ $this->old_wp_scripts = isset( $GLOBALS['wp_scripts'] ) ? $GLOBALS['wp_scripts'] : null;
+ $this->old_wp_styles = isset( $GLOBALS['wp_styles'] ) ? $GLOBALS['wp_styles'] : null;
+
+ remove_action( 'wp_default_scripts', 'wp_default_scripts' );
+ remove_action( 'wp_default_styles', 'wp_default_styles' );
+
+ $GLOBALS['wp_scripts'] = new WP_Scripts();
+ $GLOBALS['wp_scripts']->default_version = get_bloginfo( 'version' );
+ $GLOBALS['wp_styles'] = new WP_Styles();
+ $GLOBALS['wp_styles']->default_version = get_bloginfo( 'version' );
+ }
+
+ function tearDown() {
+ $GLOBALS['wp_scripts'] = $this->old_wp_scripts;
+ $GLOBALS['wp_styles'] = $this->old_wp_styles;
+ add_action( 'wp_default_scripts', 'wp_default_scripts' );
+ add_action( 'wp_default_styles', 'wp_default_styles' );
+ parent::tearDown();
+ }
+
+ function test_should_have_defaults_on_frontend() {
+ $expected = "<link rel='preconnect' href='http://s.w.org'>\r\n";
+
+ $this->expectOutputString( $expected );
+
+ wp_resource_hints();
+ }
+
+ function test_dns_prefetching() {
+ $expected = "<link rel='dns-prefetch' href='http://wordpress.org'>\r\n" .
+ "<link rel='dns-prefetch' href='https://google.com'>\r\n" .
+ "<link rel='dns-prefetch' href='make.wordpress.org'>\r\n" .
+ "<link rel='preconnect' href='http://s.w.org'>\r\n";
+
+ add_filter( 'wp_resource_hints', array( $this, '_add_dns_prefetch_domains' ), 10, 2 );
+
+ $actual = get_echo( 'wp_resource_hints' );
+
+ remove_filter( 'wp_resource_hints', array( $this, '_add_dns_prefetch_domains' ) );
+
+ $this->assertEquals( $expected, $actual );
+ }
+
+ function _add_dns_prefetch_domains( $hints, $method ) {
+ if ( 'dns-prefetch' === $method ) {
+ $hints[] = 'http://wordpress.org';
+ $hints[] = 'https://google.com';
+ $hints[] = '//make.wordpress.org';
+ }
+
+ return $hints;
+ }
+
+ function test_prerender() {
+ $expected = "<link rel='preconnect' href='http://s.w.org'>\r\n" .
+ "<link rel='prerender' href='https://make.wordpress.org/great-again'>\r\n" .
+ "<link rel='prerender' href='http://jobs.wordpress.net'>\r\n" .
+ "<link rel='prerender' href='//core.trac.wordpress.org'>\r\n";
+
+ add_filter( 'wp_resource_hints', array( $this, '_add_prerender_urls' ), 10, 2 );
+
+ $actual = get_echo( 'wp_resource_hints' );
+
+ remove_filter( 'wp_resource_hints', array( $this, '_add_prerender_urls' ) );
+
+ $this->assertEquals( $expected, $actual );
+ }
+
+ function _add_prerender_urls( $hints, $method ) {
+ if ( 'prerender' === $method ) {
+ $hints[] = 'https://make.wordpress.org/great-again';
+ $hints[] = 'http://jobs.wordpress.net';
+ $hints[] = '//core.trac.wordpress.org';
+ }
+
+ return $hints;
+ }
+
+ function test_parse_url_dns_prefetch() {
+ $expected = "<link rel='dns-prefetch' href='http://make.wordpress.org'>\r\n" .
+ "<link rel='preconnect' href='http://s.w.org'>\r\n";
+
+ add_filter( 'wp_resource_hints', array( $this, '_add_dns_prefetch_long_urls' ), 10, 2 );
+
+ $actual = get_echo( 'wp_resource_hints' );
+
+ remove_filter( 'wp_resource_hints', array( $this, '_add_dns_prefetch_long_urls' ) );
+
+ $this->assertEquals( $expected, $actual );
+ }
+
+ function _add_dns_prefetch_long_urls( $hints, $method ) {
+ if ( 'dns-prefetch' === $method ) {
+ $hints[] = 'http://make.wordpress.org/wp-includes/css/editor.css';
+ }
+
+ return $hints;
+ }
+
+ /**
+ * @group foo
+ */
+ function test_dns_prefetch_styles() {
+ $expected = "<link rel='dns-prefetch' href='http://fonts.googleapis.com'>\r\n" .
+ "<link rel='preconnect' href='http://s.w.org'>\r\n";
+
+ $args = array(
+ 'family' => 'Open+Sans:400',
+ 'subset' => 'latin',
+ );
+
+ wp_enqueue_style( 'googlefonts', add_query_arg( $args, '//fonts.googleapis.com/css' ) );
+
+ $actual = get_echo( 'wp_resource_hints' );
+
+ wp_dequeue_style( 'googlefonts' );
+
+ $this->assertEquals( $expected, $actual );
+
+ }
+
+ function test_dns_prefetch_scripts() {
+ $expected = "<link rel='dns-prefetch' href='http://fonts.googleapis.com'>\r\n" .
+ "<link rel='preconnect' href='http://s.w.org'>\r\n";
+
+ $args = array(
+ 'family' => 'Open+Sans:400',
+ 'subset' => 'latin',
+ );
+
+ wp_enqueue_script( 'googlefonts', add_query_arg( $args, '//fonts.googleapis.com/css' ) );
+
+ $actual = get_echo( 'wp_resource_hints' );
+
+ wp_dequeue_style( 'googlefonts' );
+
+ $this->assertEquals( $expected, $actual );
+ }
+
+}
</ins></span></pre>
</div>
</div>
</body>
</html>