From fdcff8b475b86f4a724d92ee69f091651e0f27b9 Mon Sep 17 00:00:00 2001
From: Sergey Biryukov <sergeybiryukov@git.wordpress.org>
Date: Tue, 20 Oct 2020 20:09:39 +0000
Subject: [PATCH] Comments: Add a filter for top level comments query arguments
 in `comments_template()`.

Props hellofromTonya, Howdy_McGee, garrett-eclipse, davidbaumwald, thomaslhotta.
Fixes #38074.

git-svn-id: https://develop.svn.wordpress.org/trunk@49256 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/comment-template.php          |  21 ++-
 .../tests/comment/commentsTemplate.php        | 120 ++++++++++++++++++
 2 files changed, 140 insertions(+), 1 deletion(-)

diff --git a/src/wp-includes/comment-template.php b/src/wp-includes/comment-template.php
index e3cfdef312..943113605c 100644
--- a/src/wp-includes/comment-template.php
+++ b/src/wp-includes/comment-template.php
@@ -1434,6 +1434,24 @@ function comments_template( $file = '/comments.php', $separate_comments = false
 				$top_level_args['include_unapproved'] = $comment_args['include_unapproved'];
 			}
 
+			/**
+			 * Filters the arguments used in the top level comments query.
+			 *
+			 * @since 5.6.0
+			 *
+			 * @see WP_Comment_Query::__construct()
+			 *
+			 * @param array $top_level_args {
+			 *     The top level query arguments for the comments template.
+			 *
+			 *     @type bool         $count   Whether to return a comment count.
+			 *     @type string|array $orderby The field(s) to order by.
+			 *     @type int          $post_id The post ID.
+			 *     @type string|array $status  The comment status to limit results by.
+			 * }
+			 */
+			$top_level_args = apply_filters( 'comments_template_top_level_query_args', $top_level_args );
+
 			$top_level_count = $top_level_query->query( $top_level_args );
 
 			$comment_args['offset'] = ( ceil( $top_level_count / $per_page ) - 1 ) * $per_page;
@@ -1463,7 +1481,8 @@ function comments_template( $file = '/comments.php', $separate_comments = false
 	 *     @type int          $number                    Number of comments to fetch.
 	 * }
 	 */
-	$comment_args  = apply_filters( 'comments_template_query_args', $comment_args );
+	$comment_args = apply_filters( 'comments_template_query_args', $comment_args );
+
 	$comment_query = new WP_Comment_Query( $comment_args );
 	$_comments     = $comment_query->comments;
 
diff --git a/tests/phpunit/tests/comment/commentsTemplate.php b/tests/phpunit/tests/comment/commentsTemplate.php
index d5bf72d2f8..5aff968ae1 100644
--- a/tests/phpunit/tests/comment/commentsTemplate.php
+++ b/tests/phpunit/tests/comment/commentsTemplate.php
@@ -960,4 +960,124 @@ class Tests_Comment_CommentsTemplate extends WP_UnitTestCase {
 		$found_cids = array_map( 'intval', $matches[1] );
 		$this->assertSame( array( $comment_3 ), $found_cids );
 	}
+
+	/**
+	 * @ticket 38074
+	 * @dataProvider data_comments_template_top_level_query_args
+	 *
+	 * @param array $expected             Array of expected values.
+	 * @param array $query_args           Args for the 'comments_template_query_args' filter.
+	 * @param array $top_level_query_args Args for the 'comments_template_top_level_query_args' filter.
+	 */
+	public function test_comments_template_top_level_query_args( $expected, $query_args, $top_level_query_args ) {
+		$now         = time();
+		$offset      = 0;
+		$p           = self::factory()->post->create();
+		$comment_ids = array();
+
+		for ( $num = 1; $num <= 6; $num++ ) {
+			$comment_ids[ $num ] = self::factory()->comment->create(
+				array(
+					'comment_post_ID'  => $p,
+					'comment_content'  => "{$num}",
+					'comment_date_gmt' => gmdate( 'Y-m-d H:i:s', $now - 100 * $num ),
+				)
+			);
+			add_comment_meta( $comment_ids[ $num ], 'featured', $num > 3 ? '1' : '0' );
+		}
+
+		update_option( 'comment_order', 'asc' );
+		update_option( 'comments_per_page', 3 );
+		update_option( 'page_comments', 1 );
+		update_option( 'default_comments_page', 'newest' );
+
+		add_filter(
+			'comments_template_query_args',
+			function ( $args ) use ( &$offset, $query_args ) {
+				$offset = $args['offset'];
+
+				return array_merge( $args, $query_args );
+			}
+		);
+
+		if ( ! empty( $top_level_query_args ) ) {
+			add_filter(
+				'comments_template_top_level_query_args',
+				function ( $args ) use ( $top_level_query_args ) {
+					return array_merge( $args, $top_level_query_args );
+				}
+			);
+		}
+
+		$this->go_to( get_permalink( $p ) );
+
+		$found = get_echo( 'comments_template' );
+		preg_match_all( '/id="comment-([0-9]+)"/', $found, $matches );
+
+		$expected_ids = array();
+		foreach ( $expected['ids'] as $index ) {
+			$expected_ids[] = $comment_ids[ $index ];
+		}
+
+		$this->assertSame( $expected_ids, array_map( 'intval', $matches[1] ) );
+		$this->assertEquals( $expected['offset'], $offset );
+	}
+
+	public function data_comments_template_top_level_query_args() {
+		return array(
+			array(
+				array(
+					'ids'    => array(),
+					'offset' => 3,
+				),
+				array(
+					'meta_key'   => 'featured',
+					'meta_value' => '1',
+				),
+				array(),
+			),
+			array(
+				array(
+					'ids'    => array(),
+					'offset' => 3,
+				),
+				array(
+					'order'      => 'DESC',
+					'meta_key'   => 'featured',
+					'meta_value' => '0',
+				),
+				array(),
+			),
+			array(
+				array(
+					'ids'    => array( 6, 5, 4 ),
+					'offset' => 0,
+				),
+				array(
+					'meta_key'   => 'featured',
+					'meta_value' => '1',
+				),
+				array(
+					'meta_key'   => 'featured',
+					'meta_value' => '1',
+				),
+			),
+			array(
+				array(
+					'ids'    => array( 4, 5, 6 ),
+					'offset' => 0,
+				),
+				array(
+					'order'      => 'DESC',
+					'meta_key'   => 'featured',
+					'meta_value' => '1',
+				),
+				array(
+					'order'      => 'DESC',
+					'meta_key'   => 'featured',
+					'meta_value' => '1',
+				),
+			),
+		);
+	}
 }