Changeset 48990 for trunk/tests/phpunit/tests/comment/query.php

Timestamp:

09/17/2020 07:53:47 PM (4 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.

File:

• trunk/tests/phpunit/tests/comment/query.php (modified) (1 diff)

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 ) );
+    }
 }