Ticket #45800: 45800.4.diff

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

@@ -379 +379 @@
                         $this->meta_query_clauses = $this->meta_query->get_sql( 'comment', $wpdb->comments, 'comment_ID', $this );
                 }
 
+                $comment_ids = null;
+
+                /**
+                 * Filter the comments data before the query takes place.
+                 *
+                 * Return a non-null value to bypass WordPress's default comment queries.
+                 *
+                 * The expected return type from this filter depends on the value passed in the request query_vars:
+                 * When $this->query_vars['count'] is set, the filter should return the comment count as an int.
+                 * When `'ids' == $this->query_vars['fields']`, the filter should return an array of comment ids.
+                 * Otherwise the filter should return an array of WP_Comment objects.
+                 *
+                 * @since 5.3.0
+                 *
+                 * @param array|null       $comment_ids Return an array of comment data to short-circuit WP's comment query,
+                 *                                      or null to allow WP to run its normal queries.
+                 * @param WP_Comment_Query $this        The WP_Comment_Query instance, passed by reference.
+                 */
+                $comment_ids = apply_filters_ref_array( 'comments_pre_query', array( $comment_ids, &$this ) );
+
+                if ( null !== $comment_ids ) {
+                        $this->comments = $comment_ids;
+                        return $this->comments;
+                }
+
                 /*
                  * Only use the args defined in the query_var_defaults to compute the key,
                  * but ignore 'fields', which does not affect query results.

tests/phpunit/tests/comment/query.php

@@ -4882 +4882 @@
 
                 $this->assertEqualSets( $c1, $found );
         }
+
+        /**
+         * @ticket 45800
+         */
+        public function test_comments_pre_query_filter_should_bypass_database_query() {
+                global $wpdb;
+
+                add_filter( 'comments_pre_query', array( __CLASS__, 'filter_comments_pre_query' ), 10, 2 );
+
+                $num_queries = $wpdb->num_queries;
+
+                $q       = new WP_Comment_Query();
+                $results = $q->query(
+                        array(
+                                'fields' => 'ids',
+                        )
+                );
+
+                remove_filter( 'comments_pre_query', array( __CLASS__, 'filter_comments_pre_query' ), 10, 2 );
+
+                // Make sure no queries were executed.
+                $this->assertSame( $num_queries, $wpdb->num_queries );
+
+                // We manually inserted a non-existing site and overrode the results with it.
+                $this->assertSame( array( 555 ), $q->comments );
+
+                // Make sure manually setting total_users doesn't get overwritten.
+                $this->assertEquals( 1, $q->found_comments );
+        }
+
+        public static function filter_comments_pre_query( $comments, $query ) {
+                $query->found_comments = 1;
+
+                return array( 555 );
+        }
 }