Changeset 47018 for trunk/src/wp-includes/class-wp-query.php

Timestamp:

12/28/2019 09:18:03 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Bootstrap/Load: Make handling the /favicon.ico requests more flexible.

Previously, wp_favicon_request() was introduced in [13205] to avoid a performance hit of serving a full 404 page on every favicon request.

While working as intended, that implementation did not provide a way for theme or plugin authors to manage the behavior of favicon requests.

This changeset implements the following logic (only applied if WordPress is installed in the root directory):

• If there is a Site Icon set in Customizer, redirect /favicon.ico requests to that icon.
• Otherwise, use the WordPress logo as a default icon.
• If a physical /favicon.ico file exists, do nothing, let the server handle the request.

Handling /favicon.ico is now more consistent with handling /robots.txt requests.

New functions and hooks:

• Introduce is_favicon() conditional tag to complement is_robots().
• Introduce do_favicon action to complement do_robots and use it in template loader.
• Introduce do_favicon() function, hooked to the above action by default, to complement do_robots().
• Introduce do_faviconico action to complement do_robotstxt, for plugins to override the default behavior.
• Mark wp_favicon_request() as deprecated in favor of do_favicon().

Props jonoaldersonwp, birgire, joostdevalk, mukesh27, SergeyBiryukov.
Fixes #47398.

File:

• trunk/src/wp-includes/class-wp-query.php (modified) (6 diffs)

trunk/src/wp-includes/class-wp-query.php

@@ -390 +390 @@
      */
     public $is_robots = false;
+
+    /**
+     * Signifies whether the current query is for the favicon.ico file.
+     *
+     * @since 5.4.0
+     * @var bool
+     */
+    public $is_favicon = false;
 
     /**
@@ -479 +487 @@
         $this->is_singular          = false;
         $this->is_robots            = false;
+        $this->is_favicon           = false;
         $this->is_posts_page        = false;
         $this->is_post_type_archive = false;
@@ -745 +754 @@
         if ( ! empty( $qv['robots'] ) ) {
             $this->is_robots = true;
+        } elseif ( ! empty( $qv['favicon'] ) ) {
+            $this->is_favicon = true;
         }
 
@@ -958 +969 @@
         }
 
-        if ( ! ( $this->is_singular || $this->is_archive || $this->is_search || $this->is_feed || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) || $this->is_trackback || $this->is_404 || $this->is_admin || $this->is_robots ) ) {
+        if ( ! ( $this->is_singular || $this->is_archive || $this->is_search || $this->is_feed
+                || ( defined( 'REST_REQUEST' ) && REST_REQUEST )
+                || $this->is_trackback || $this->is_404 || $this->is_admin || $this->is_robots || $this->is_favicon ) ) {
             $this->is_home = true;
         }
@@ -4008 +4021 @@
 
     /**
-     * Is the query for the robots file?
+     * Is the query for the robots.txt file?
      *
      * @since 3.1.0
@@ -4016 +4029 @@
     public function is_robots() {
         return (bool) $this->is_robots;
+    }
+
+    /**
+     * Is the query for the favicon.ico file?
+     *
+     * @since 5.4.0
+     *
+     * @return bool
+     */
+    public function is_favicon() {
+        return (bool) $this->is_favicon;
     }