Changeset 38901

Timestamp:

10/25/2016 04:46:36 AM (9 years ago)

Author:

westonruter

Message:

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 #38377.

Location:

trunk

Files:

• src/wp-admin/js/customize-controls.js (modified) (3 diffs)
• src/wp-includes/general-template.php (modified) (1 diff)
• tests/phpunit/tests/general/template.php (modified) (4 diffs)

trunk/src/wp-admin/js/customize-controls.js

@@ -3334 +3334 @@
          */
         setImageFromAttachment: function( attachment ) {
-            var sizes = [ 'site_icon-32', 'thumbnail', 'full' ],
+            var sizes = [ 'site_icon-32', 'thumbnail', 'full' ], link,
                 icon;
 
@@ -3348 +3348 @@
             this.setting( attachment.id );
 
+            if ( ! icon ) {
+                return;
+            }
+
             // Update the icon in-browser.
-            $( 'link[sizes="32x32"]' ).attr( 'href', icon.url );
+            link = $( 'link[rel="icon"][sizes="32x32"]' );
+            link.attr( 'href', icon.url );
         },
 
@@ -3366 +3371 @@
             this.setting( '' );
             this.renderContent(); // Not bound to setting change when emptying.
-            $( 'link[rel="icon"]' ).attr( 'href', '' );
+            $( 'link[rel="icon"][sizes="32x32"]' ).attr( 'href', '/favicon.ico' ); // Set to default.
         }
     });

trunk/src/wp-includes/general-template.php

@@ -2777 +2777 @@
     }
 
-    $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 ) ) ),
-    );
+    $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 ) );
+    }
 
     /**

trunk/tests/phpunit/tests/general/template.php

@@ -24 +24 @@
 
     function tearDown() {
+        global $wp_customize;
         $this->_remove_custom_logo();
+        $this->_remove_site_icon();
+        $wp_customize = null;
 
         parent::tearDown();
@@ -52 +55 @@
         $this->expectOutputString( $this->site_icon_url );
         site_icon_url();
-        $this->_remove_site_icon();
     }
 
@@ -118 +120 @@
         $this->expectOutputString( $output );
         wp_site_icon();
-
-        $this->_remove_site_icon();
     }
 
@@ -144 +144 @@
         wp_site_icon();
         remove_filter( 'site_icon_meta_tags', array( $this, '_custom_site_icon_meta_tag' ) );
-
-        $this->_remove_site_icon();
+    }
+
+    /**
+     * @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();
+    }
+
+    /**
+     * @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();
     }