<!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>[38901] trunk: Customize: Prevent absent site icon `link` from outputting an empty string as `href` in customizer; use `/favicon.ico` as fallback.</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/38901">38901</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/38901","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-10-25 04:46:36 +0000 (Tue, 25 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'>Customize: Prevent absent site icon `link` from outputting an empty string as `href` in customizer; use `/favicon.ico` as fallback.
An empty string causes some browsers to use the current URL as the `href`. When using `history.replaceState()` Chrome will re-fetch the favicon with each call, meaning that `customize.php` gets hit with wasted requests which tax the server.
Fixes <a href="https://core.trac.wordpress.org/ticket/38377">#38377</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjscustomizecontrolsjs">trunk/src/wp-admin/js/customize-controls.js</a></li>
<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>
<li><a href="#trunktestsphpunittestsgeneraltemplatephp">trunk/tests/phpunit/tests/general/template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjscustomizecontrolsjs"></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/js/customize-controls.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/customize-controls.js 2016-10-25 04:36:00 UTC (rev 38900)
+++ trunk/src/wp-admin/js/customize-controls.js 2016-10-25 04:46:36 UTC (rev 38901)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3333,7 +3333,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {object} attachment
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> setImageFromAttachment: function( attachment ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var sizes = [ 'site_icon-32', 'thumbnail', 'full' ],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var sizes = [ 'site_icon-32', 'thumbnail', 'full' ], link,
</ins><span class="cx" style="display: block; padding: 0 10px"> icon;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> _.each( sizes, function( size ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3347,8 +3347,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Set the Customizer setting; the callback takes care of rendering.
</span><span class="cx" style="display: block; padding: 0 10px"> this.setting( attachment.id );
</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 ( ! icon ) {
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Update the icon in-browser.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $( 'link[sizes="32x32"]' ).attr( 'href', icon.url );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ link = $( 'link[rel="icon"][sizes="32x32"]' );
+ link.attr( 'href', icon.url );
</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">@@ -3365,7 +3370,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> this.params.attachment = {};
</span><span class="cx" style="display: block; padding: 0 10px"> this.setting( '' );
</span><span class="cx" style="display: block; padding: 0 10px"> this.renderContent(); // Not bound to setting change when emptying.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $( 'link[rel="icon"]' ).attr( 'href', '' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $( 'link[rel="icon"][sizes="32x32"]' ).attr( 'href', '/favicon.ico' ); // Set to default.
</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="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-25 04:36:00 UTC (rev 38900)
+++ trunk/src/wp-includes/general-template.php 2016-10-25 04:46:36 UTC (rev 38901)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2776,12 +2776,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</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">- $meta_tags = array(
- sprintf( '<link rel="icon" href="%s" sizes="32x32" />', esc_url( get_site_icon_url( 32 ) ) ),
- sprintf( '<link rel="icon" href="%s" sizes="192x192" />', esc_url( get_site_icon_url( 192 ) ) ),
- sprintf( '<link rel="apple-touch-icon-precomposed" href="%s" />', esc_url( get_site_icon_url( 180 ) ) ),
- sprintf( '<meta name="msapplication-TileImage" content="%s" />', esc_url( get_site_icon_url( 270 ) ) ),
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $meta_tags = array();
+ $icon_32 = get_site_icon_url( 32 );
+ if ( empty( $icon_32 ) && is_customize_preview() ) {
+ $icon_32 = '/favicon.ico'; // Serve default favicon URL in customizer so element can be updated for preview.
+ }
+ if ( $icon_32 ) {
+ $meta_tags[] = sprintf( '<link rel="icon" href="%s" sizes="32x32" />', esc_url( $icon_32 ) );
+ }
+ $icon_192 = get_site_icon_url( 192 );
+ if ( $icon_192 ) {
+ $meta_tags[] = sprintf( '<link rel="icon" href="%s" sizes="192x192" />', esc_url( $icon_192 ) );
+ }
+ $icon_180 = get_site_icon_url( 180 );
+ if ( $icon_180 ) {
+ $meta_tags[] = sprintf( '<link rel="apple-touch-icon-precomposed" href="%s" />', esc_url( $icon_180 ) );
+ }
+ $icon_270 = get_site_icon_url( 270 );
+ if ( $icon_270 ) {
+ $meta_tags[] = sprintf( '<meta name="msapplication-TileImage" content="%s" />', esc_url( $icon_270 ) );
+ }
</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"> * Filters the site icon meta tags, so Plugins can add their own.
</span></span></pre></div>
<a id="trunktestsphpunittestsgeneraltemplatephp"></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/template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/general/template.php 2016-10-25 04:36:00 UTC (rev 38900)
+++ trunk/tests/phpunit/tests/general/template.php 2016-10-25 04:46:36 UTC (rev 38901)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,7 +23,10 @@
</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"> function tearDown() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $wp_customize;
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->_remove_custom_logo();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->_remove_site_icon();
+ $wp_customize = null;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> parent::tearDown();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -51,7 +54,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->_set_site_icon();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->expectOutputString( $this->site_icon_url );
</span><span class="cx" style="display: block; padding: 0 10px"> site_icon_url();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->_remove_site_icon();
</del><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">@@ -117,8 +119,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->expectOutputString( $output );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_site_icon();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- $this->_remove_site_icon();
</del><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">@@ -143,11 +143,54 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'site_icon_meta_tags', array( $this, '_custom_site_icon_meta_tag' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_site_icon();
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'site_icon_meta_tags', array( $this, '_custom_site_icon_meta_tag' ) );
</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">- $this->_remove_site_icon();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @group site_icon
+ * @ticket 38377
+ */
+ function test_customize_preview_wp_site_icon_empty() {
+ global $wp_customize;
+ wp_set_current_user( $this->factory()->user->create( array( 'role' => 'administrator' ) ) );
+
+ require_once ABSPATH . WPINC . '/class-wp-customize-manager.php';
+ $wp_customize = new WP_Customize_Manager();
+ $wp_customize->register_controls();
+ $wp_customize->start_previewing_theme();
+
+ $this->expectOutputString( '<link rel="icon" href="/favicon.ico" sizes="32x32" />' . "\n" );
+ wp_site_icon();
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @group site_icon
+ * @ticket 38377
+ */
+ function test_customize_preview_wp_site_icon_dirty() {
+ global $wp_customize;
+ wp_set_current_user( $this->factory()->user->create( array( 'role' => 'administrator' ) ) );
+
+ require_once ABSPATH . WPINC . '/class-wp-customize-manager.php';
+ $wp_customize = new WP_Customize_Manager();
+ $wp_customize->register_controls();
+ $wp_customize->start_previewing_theme();
+
+ $attachment_id = $this->_insert_attachment();
+ $wp_customize->set_post_value( 'site_icon', $attachment_id );
+ $wp_customize->get_setting( 'site_icon' )->preview();
+ $output = array(
+ sprintf( '<link rel="icon" href="%s" sizes="32x32" />', esc_url( wp_get_attachment_image_url( $attachment_id, 32 ) ) ),
+ sprintf( '<link rel="icon" href="%s" sizes="192x192" />', esc_url( wp_get_attachment_image_url( $attachment_id, 192 ) ) ),
+ sprintf( '<link rel="apple-touch-icon-precomposed" href="%s" />', esc_url( wp_get_attachment_image_url( $attachment_id, 180 ) ) ),
+ sprintf( '<meta name="msapplication-TileImage" content="%s" />', esc_url( wp_get_attachment_image_url( $attachment_id, 270 ) ) ),
+ '',
+ );
+ $output = implode( "\n", $output );
+ $this->expectOutputString( $output );
+ wp_site_icon();
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Builds and retrieves a custom site icon meta tag.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.3.0
</span></span></pre>
</div>
</div>
</body>
</html>