Changeset 54161 for trunk/tests/phpunit/tests/general/feedLinksExtra.php

Timestamp:

09/14/2022 05:12:20 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Feeds: Add a set of fine-grained filters to disable the different types of feed links separately.

The previously available set of filters in the feed_links() function to enable or disable display of various feed links was quite limited:

• feed_links_show_posts_feed to control the main feed
• feed_links_show_comments_feed to control both the global comments feed and the comment feed for singular posts.

In order to disable the other feeds (post type archive, category, tag, custom taxonomy, author archive, search results), one would have to unhook feed_links_extra() from wp_head, but that would completely remove all of those feeds, as well as the single post comments feed.

To allow for more flexibility, this commit introduces a full set of filters in the feed_links_extra() function to control each one of the feeds independently, including a way to enable/disable the single post comments feed when the global comments feed is disabled/enabled:

• feed_links_extra_show_post_comments_feed
• feed_links_extra_show_post_type_archive_feed
• feed_links_extra_show_category_feed
• feed_links_extra_show_tag_feed
• feed_links_extra_show_tax_feed
• feed_links_extra_show_author_feed
• feed_links_extra_show_search_feed

All of them default to true, except for feed_links_extra_show_post_comments_feed which defaults to the result of feed_links_show_comments_feed to ensure backward compatibility.

Follow-up to [33838], [33839], [53125].

Props lopo, mukesh27, audrasjb, SergeyBiryukov.
Fixes #55904.

File:

• trunk/tests/phpunit/tests/general/feedLinksExtra.php (modified) (1 diff)

trunk/tests/phpunit/tests/general/feedLinksExtra.php

@@ -580 +580 @@
         $this->assertNotEmpty( get_echo( 'feed_links_extra' ) );
     }
+
+    /**
+     * @dataProvider data_feed_links_extra_should_output_nothing_when_filters_return_false
+     *
+     * @ticket 55904
+     *
+     * @param string $type   The name of the test class property containing the object ID.
+     * @param string $filter The name of the filter to set to false.
+     */
+    public function test_feed_links_extra_should_output_nothing_when_filters_return_false( $type, $filter ) {
+        $permalink = $this->helper_get_the_permalink( $type );
+        $this->go_to( $permalink );
+
+        add_filter( $filter, '__return_false' );
+
+        $this->assertEmpty( get_echo( 'feed_links_extra' ) );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_feed_links_extra_should_output_nothing_when_filters_return_false() {
+        return array(
+            'a post with a comment' => array(
+                'type'   => 'post_with_comment',
+                'filter' => 'feed_links_extra_show_post_comments_feed',
+            ),
+            'a custom post type'    => array(
+                'type'   => 'post_type',
+                'filter' => 'feed_links_extra_show_post_type_archive_feed',
+            ),
+            'a category'            => array(
+                'type'   => 'category',
+                'filter' => 'feed_links_extra_show_category_feed',
+            ),
+            'a tag'                 => array(
+                'type'   => 'tag',
+                'filter' => 'feed_links_extra_show_tag_feed',
+            ),
+            'a taxonomy'            => array(
+                'type'   => 'tax',
+                'filter' => 'feed_links_extra_show_tax_feed',
+            ),
+            'an author'             => array(
+                'type'   => 'author',
+                'filter' => 'feed_links_extra_show_author_feed',
+            ),
+            'search results'        => array(
+                'type'   => 'search',
+                'filter' => 'feed_links_extra_show_search_feed',
+            ),
+        );
+    }
 }