Ticket #20899: 20899.4.diff

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

@@ -346 +346 @@
         public $is_comment_feed = false;
 
         /**
+         * Set if query is home feed display.
+         *
+         * @since 4.8.0
+         * @access public
+         * @var bool
+         */
+        public $is_home_feed = false;
+
+        /**
+         * Set if query is custom feed display.
+         *
+         * @since 4.8.0
+         * @access public
+         * @var bool
+         */
+        public $is_custom_feed = false;
+
+        /**
          * Set if query is trackback.
          *
          * @since 1.5.0
@@ -511 +529 @@
                 $this->is_search = false;
                 $this->is_feed = false;
                 $this->is_comment_feed = false;
+                $this->is_home_feed = false;
+                $this->is_custom_feed = false;
                 $this->is_trackback = false;
                 $this->is_home = false;
                 $this->is_404 = false;
@@ -927 +947 @@
                                 $this->is_archive = true;
                 }
 
-                if ( '' != $qv['feed'] )
+                if ( '' != $qv['feed'] ) {
                         $this->is_feed = true;
+                        if ( ! in_array( $qv['feed'], array( 'feed', 'rss', 'rss2', 'atom', 'rdf' ) ) ) {
+                                $this->is_custom_feed = true;
+                        }
+                }
 
                 if ( '' != $qv['embed'] ) {
                         $this->is_embed = true;
@@ -957 +981 @@
                 if ( $this->is_feed && ( !empty($qv['withcomments']) || ( empty($qv['withoutcomments']) && $this->is_singular ) ) )
                         $this->is_comment_feed = true;
 
-                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_home = true;
 
+
+                if ( !( $this->is_singular || $this->is_archive || $this->is_search || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) || $this->is_trackback || $this->is_404 || $this->is_admin || $this->is_robots || $this->is_custom_feed ) ) {
+                        if ( $this->is_feed ) {
+                                if ( ! $this->is_comment_feed ) {
+                                        $this->is_home_feed = true;
+                                }
+                        } else {
+                                $this->is_home = true;
+                        }
+
+                }
+
                 // Correct is_* for page_on_front and page_for_posts
                 if ( $this->is_home && 'page' == get_option('show_on_front') && get_option('page_on_front') ) {
                         $_query = wp_parse_args($this->query);
@@ -3676 +3710 @@
         }
 
         /**
+         * Is the query for a hompage feed?
+         *
+         * @since 4.8.0
+         *
+         * @return bool
+         */
+        public function is_home_feed() {
+                return (bool) $this->is_home_feed;
+        }
+
+        /**
+         * Is the query for a custom feed?
+         *
+         * @since 4.8.0
+         *
+         * @return bool
+         */
+        public function is_custom_feed() {
+                return (bool) $this->is_custom_feed;
+        }
+
+        /**
          * Is the query for the front page of the site?
          *
          * This is for what is displayed at your site's main URL.

src/wp-includes/query.php

@@ -383 +383 @@
 }
 
 /**
+ * Is the query for the blog homepage feed?
+ *
+ * @since 4.8.0
+ *
+ * @global WP_Query $wp_query Global WP_Query instance.
+ *
+ * @return bool
+ */
+function is_home_feed() {
+        global $wp_query;
+
+        if ( ! isset( $wp_query ) ) {
+                _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' );
+                return false;
+        }
+
+        return $wp_query->is_home_feed();
+}
+
+/**
+ * Is the query for the custom feed?
+ *
+ * @since 4.8.0
+ *
+ * @global WP_Query $wp_query Global WP_Query instance.
+ *
+ * @return bool
+ */
+function is_custom_feed() {
+        global $wp_query;
+
+        if ( ! isset( $wp_query ) ) {
+                _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' );
+                return false;
+        }
+
+        return $wp_query->is_custom_feed();
+}
+
+/**
  * Is the query for the front page of the site?
  *
  * This is for what is displayed at your site's main URL.

tests/phpunit/includes/testcase.php

@@ -626 +626 @@
                         'is_day',
                         'is_embed',
                         'is_feed',
+                        'is_home_feed',
+                        'is_custom_feed',
                         'is_front_page',
                         'is_home',
                         'is_month',

tests/phpunit/tests/feed/rss2.php

@@ -63 +63 @@
 
                 $this->set_permalink_structure( '/%year%/%monthnum%/%day%/%postname%/' );
                 create_initial_taxonomies();
+
+                // Add a custom feed
+                add_feed( 'custom', 'do_rss2' );
+
         }
 
         /**
@@ -296 +300 @@
                 $this->go_to( 'feed/' );
 
                 // Verify the query object is a feed.
-                $this->assertQueryTrue( 'is_feed' );
+                $this->assertQueryTrue( 'is_feed', 'is_home_feed' );
 
                 // Queries performed on valid feed endpoints should contain posts.
                 $this->assertTrue( have_posts() );
@@ -313 +317 @@
                 $this->assertEquals( 1, count( $rss ) );
         }
 
+        function test_valid_custom_feed_endpoint() {
+                // An example of a valid home feed endpoint.
+                $this->go_to( 'feed/custom' );
+
+                // Verify the query object is a feed.
+                $this->assertQueryTrue( 'is_feed', 'is_custom_feed' );
+
+                // Check to see if we have the expected XML output from the feed template.
+                $feed = $this->do_rss2();
+
+                $xml = xml_to_array( $feed );
+
+                // Get the <rss> child element of <xml>.
+                $rss = xml_find( $xml, 'rss' );
+
+                // There should only be one <rss> child element.
+                $this->assertEquals( 1, count( $rss ) );
+        }
+
         /*
          * Check to make sure we are rendering feed templates for the taxonomy feeds.
          * e.g. https://example.com/category/foo/feed/
@@ -408 +431 @@
          *
          * @ticket 30210
          */
-        function test_valid_single_post_comment_feed_endpoint() {
+        function test_valid_singular_comment_feed_endpoint() {
                 // An example of an valid date archive feed endpoint.
                 $this->go_to( get_post_comments_feed_link( self::$posts[0] ) );
 

tests/phpunit/tests/query/conditionals.php

@@ -253 +253 @@
                 // long version
                 foreach ($feeds as $feed) {
                         $this->go_to("/feed/{$feed}/");
-                        $this->assertQueryTrue('is_feed');
+                        $this->assertQueryTrue('is_feed', 'is_home_feed');
                 }
 
                 // short version
                 foreach ($feeds as $feed) {
                         $this->go_to("/{$feed}/");
-                        $this->assertQueryTrue('is_feed');
+                        $this->assertQueryTrue('is_feed', 'is_home_feed');
                 }
 
         }
@@ -269 +269 @@
                 $types = array('rss2', 'rss', 'atom');
                 foreach ($types as $type) {
                         $this->go_to(get_feed_link($type));
-                        $this->assertQueryTrue('is_feed');
+                        $this->assertQueryTrue('is_feed', 'is_home_feed');
                 }
         }