Ticket #13867: 13867.6.diff

src/wp-includes/feed-atom-comments.php

@@ -27 +27 @@
                 do_action( 'atom_comments_ns' );
         ?>
 >
-        <title type="text">
         <?php
+        $feed_title = '';
         if ( is_singular() ) {
                 /* translators: Comments feed title. %s: Post title. */
-                printf( ent2ncr( __( 'Comments on %s' ) ), get_the_title_rss() );
+                $feed_title = sprintf( ent2ncr( __( 'Comments on: %s' ) ), get_the_title_rss() );
         } elseif ( is_search() ) {
                 /* translators: Comments feed title. 1: Site title, 2: Search query. */
-                printf( ent2ncr( __( 'Comments for %1$s searching on %2$s' ) ), get_bloginfo_rss( 'name' ), get_search_query() );
+                $feed_title = sprintf( ent2ncr( __( 'Comments for %1$s searching on %2$s' ) ), get_bloginfo_rss( 'name' ), get_search_query() );
         } else {
                 /* translators: Comments feed title. %s: Site title. */
-                printf( ent2ncr( __( 'Comments for %s' ) ), get_wp_title_rss() );
+                $feed_title = sprintf( ent2ncr( __( 'Comments for %s' ) ), get_bloginfo_rss( 'name' ) . get_wp_title_rss() );
         }
+
+        /**
+         * Filters the page title for the comments feed.
+         *
+         * @since 5.9.0
+         *
+         * @param string $feed_title Comments feed page title.
+         */
+        $feed_title = apply_filters( 'comments_feed_title', $feed_title, get_the_title_rss() );
         ?>
-        </title>
+
+        <title type="text"><?php echo esc_html( $feed_title ); ?></title>
         <subtitle type="text"><?php bloginfo_rss( 'description' ); ?></subtitle>
 
         <updated><?php echo get_feed_build_date( 'Y-m-d\TH:i:s\Z' ); ?></updated>

src/wp-includes/feed-rss2-comments.php

@@ -32 +32 @@
         ?>
 >
 <channel>
-        <title>
+
         <?php
+        $feed_title = '';
         if ( is_singular() ) {
                 /* translators: Comments feed title. %s: Post title. */
-                printf( ent2ncr( __( 'Comments on: %s' ) ), get_the_title_rss() );
+                $feed_title = sprintf( ent2ncr( __( 'Comments on: %s' ) ), get_the_title_rss() );
         } elseif ( is_search() ) {
                 /* translators: Comments feed title. 1: Site title, 2: Search query. */
-                printf( ent2ncr( __( 'Comments for %1$s searching on %2$s' ) ), get_bloginfo_rss( 'name' ), get_search_query() );
+                $feed_title = sprintf( ent2ncr( __( 'Comments for %1$s searching on %2$s' ) ), get_bloginfo_rss( 'name' ), get_search_query() );
         } else {
                 /* translators: Comments feed title. %s: Site title. */
-                printf( ent2ncr( __( 'Comments for %s' ) ), get_wp_title_rss() );
+                $feed_title = sprintf( ent2ncr( __( 'Comments for %s' ) ), get_bloginfo_rss( 'name' ) . get_wp_title_rss() );
         }
+
+        /**
+         * Filters the page title for the comments feed.
+         *
+         * @since 5.9.0
+         *
+         * @param string $feed_title Comments feed page title.
+         */
+        $feed_title = apply_filters( 'comments_feed_title', $feed_title, get_the_title_rss() );
         ?>
-        </title>
+
+        <title><?php echo esc_html( $feed_title ); ?></title>
+        <!-- JBA -->
         <atom:link href="<?php self_link(); ?>" rel="self" type="application/rss+xml" />
         <link><?php ( is_single() ) ? the_permalink_rss() : bloginfo_rss( 'url' ); ?></link>
         <description><?php bloginfo_rss( 'description' ); ?></description>

tests/phpunit/tests/feed/atom.php

@@ -12 +12 @@
         public static $user_id;
         public static $posts;
         public static $category;
+        public static $post_id;
+        public static $comment_ids = array();
 
         /**
          * Setup a new user and attribute some posts.
@@ -51 +53 @@
                         wp_set_object_terms( $post, self::$category->slug, 'category' );
                 }
 
+                self::$post_id = $factory->post->create();
+
+                // Create a comment
+                self::$comment_ids[] = $factory->comment->create(
+                        array(
+                                'comment_author'   => 1,
+                                'comment_date'     => '2014-05-06 12:00:00',
+                                'comment_date_gmt' => '2014-05-06 07:00:00',
+                                'comment_post_ID'  => self::$post_id,
+                        )
+                );
         }
 
         /**
@@ -126 +139 @@
                 $this->assertSame( home_url( '/?feed=atom' ), $link[1]['attributes']['href'] );
         }
 
+        /**
+         * Test the <feed> element to make sure its present and populated
+         * with the modified version of the title.
+         *
+         * @ticket 13867
+         */
+        function test_feed_title() {
+                add_filter( 'comments_feed_title', array( $this, 'apply_comments_feed_title' ), 10, 2 );
+                $this->go_to( '?feed=comments-atom' );
+                $feed = $this->do_rss2_comments();
+                $xml  = xml_to_array( $feed );
+
+                // Get the <feed> child element of <xml>.
+                $rss = xml_find( $xml, 'feed' );
+                error_log( print_r( $rss, true) );
+                $this->assertEquals( 'Filtered Title', $rss[0]['child'][0]['child'][0]['content'] );
+        }
+
+        /**
+         * Apply the comments feed title filter.
+         *
+         * @ticket 13867
+         */
+        function apply_comments_feed_title( $item_title, $the_title_rss ) {
+                $item_title = 'Filtered Title';
+                return $item_title;
+        }
+
         /**
          * Validate <entry> child elements.
          */

tests/phpunit/tests/feed/rss2.php

@@ -13 +13 @@
         public static $posts;
         public static $category;
         public static $post_date;
+        public static $post_id;
+        public static $comment_ids = array();
 
         /**
          * Setup a new user and attribute some posts.
@@ -58 +60 @@
                 foreach ( self::$posts as $post ) {
                         wp_set_object_terms( $post, self::$category->slug, 'category' );
                 }
+
+                self::$post_id = $factory->post->create();
+
+                // Create a comment
+                self::$comment_ids[] = $factory->comment->create(
+                        array(
+                                'comment_author'   => 1,
+                                'comment_date'     => '2014-05-06 12:00:00',
+                                'comment_date_gmt' => '2014-05-06 07:00:00',
+                                'comment_post_ID'  => self::$post_id,
+                        )
+                );
         }
 
         /**
@@ -117 +131 @@
                 $this->assertCount( 1, $rss[0]['child'] );
         }
 
+        /**
+         * Test the <rss> element to make sure its present and populated
+         * with the modified version of the title.
+         *
+         * @ticket 13867
+         */
+        function test_feed_title() {
+                add_filter( 'comments_feed_title', array( $this, 'apply_comments_feed_title' ), 10, 2 );
+                $this->go_to( '/comments/feed/' );
+                $feed = $this->do_rss2_comments();
+                $xml  = xml_to_array( $feed );
+
+                // Get the <rss> child element of <xml>.
+                $rss = xml_find( $xml, 'rss' );
+                error_log( print_r( $rss, true) );
+                $this->assertEquals( 'Filtered Title', $rss[0]['child'][0]['child'][0]['content'] );
+        }
+
+        /**
+         * Apply the comments feed title filter.
+         *
+         * @ticket 13867
+         */
+        function apply_comments_feed_title( $item_title, $the_title_rss ) {
+                $item_title = 'Filtered Title';
+                return $item_title;
+        }
+
         /**
          * [test_channel_element description]
          *