Changeset 48990

Timestamp:

09/17/2020 07:53:47 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Comments: Assign the array of comment data returned from the comments_pre_query filter to the comments property of the current WP_Comment_Query instance.

This avoids the performance overhead of calling WP_Comment_Query::get_comments() twice: first when creating the object instance, then to retrieve the filtered results.

This also makes the filter a bit more consistent with other similar filters, e.g. posts_pre_query, terms_pre_query, or users_pre_query.

Follow-up to [46086].

Props dinhtungdu, imath, spacedmonkey, adamsilverstein, SergeyBiryukov.
Fixes #50521.

Location:

trunk

Files:

• src/wp-includes/class-wp-comment-query.php (modified) (2 diffs)
• tests/phpunit/tests/comment/query.php (modified) (1 diff)

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

@@ -395 +395 @@
                  * - Otherwise the filter should return an array of WP_Comment objects.
                  *
+                 * Note that if the filter returns an array of comment data, it will be assigned
+                 * to the `comments` property of the current WP_Comment_Query instance.
+                 *
+                 * Filtering functions that require pagination information are encouraged to set
+                 * the `found_comments` and `max_num_pages` properties of the WP_Comment_Query object,
+                 * passed to the filter by reference. If WP_Comment_Query does not perform a database
+                 * query, it will not have enough information to generate these values itself.
+                 *
                  * @since 5.3.0
+                 * @since 5.6.0 The returned array of comment data is assigned to the `comments` property
+                 *              of the current WP_Comment_Query instance.
                  *
                  * @param array|int|null   $comment_data Return an array of comment data to short-circuit WP's comment query,
@@ -405 +415 @@
 
                 if ( null !== $comment_data ) {
+                        if ( is_array( $comment_data ) && ! $this->query_vars['count'] ) {
+                                $this->comments = $comment_data;
+                        }
+
                         return $comment_data;
                 }

trunk/tests/phpunit/tests/comment/query.php

@@ -4917 +4917 @@
                 return array( 555 );
         }
+
+        /**
+         * @ticket 50521
+         */
+        public function test_comments_pre_query_filter_should_set_comments_property() {
+                add_filter( 'comments_pre_query', array( __CLASS__, 'filter_comments_pre_query_and_set_comments' ), 10, 2 );
+
+                $q       = new WP_Comment_Query();
+                $results = $q->query( array() );
+
+                remove_filter( 'comments_pre_query', array( __CLASS__, 'filter_comments_pre_query_and_set_comments' ), 10, 2 );
+
+                // Make sure the comments property is the same as the results.
+                $this->assertSame( $results, $q->comments );
+
+                // Make sure the comment type is `foobar`.
+                $this->assertSame( 'foobar', $q->comments[0]->comment_type );
+        }
+
+        public static function filter_comments_pre_query_and_set_comments( $comments, $query ) {
+                $c = self::factory()->comment->create(
+                        array(
+                                'comment_type'     => 'foobar',
+                                'comment_approved' => '1',
+                        )
+                );
+
+                return array( get_comment( $c ) );
+        }
 }