Changeset 32911

Timestamp:

06/23/2015 02:35:29 PM (10 years ago)

Author:

boonebgorges

Message:

In WP_Comment_Query, parse meta_query vars after the pre_get_comments hook.

[31467] included a change that involved generating meta_query SQL before the
pre_get_comments hook, with the result that pre_get_comments callbacks were
no longer able to modify comment meta queries. We fix the problem by moving the
SQL generation to after the hook.

This changeset also includes a second call to meta_query->parse_query_vars(),
to ensure that modifications to metadata-related query vars (such as meta_key
and meta_value) performed in pre_get_comments callbacks have the expected
effect on the comment query.

Fixes #32762.

Location:

trunk

Files:

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

trunk/src/wp-includes/comment.php

@@ -483 +483 @@
         $this->meta_query->parse_query_vars( $this->query_vars );
 
-        if ( ! empty( $this->meta_query->queries ) ) {
-            $meta_query_clauses = $this->meta_query->get_sql( 'comment', $wpdb->comments, 'comment_ID', $this );
-        }
-
         /**
          * Fires before comments are retrieved.
@@ -495 +491 @@
          */
         do_action_ref_array( 'pre_get_comments', array( &$this ) );
+
+        // Reparse query vars, in case they were modified in a 'pre_get_comments' callback.
+        $this->meta_query->parse_query_vars( $this->query_vars );
+        if ( ! empty( $this->meta_query->queries ) ) {
+            $meta_query_clauses = $this->meta_query->get_sql( 'comment', $wpdb->comments, 'comment_ID', $this );
+        }
 
         // $args can include anything. Only use the args defined in the query_var_defaults to compute the key.

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

@@ -1680 +1680 @@
         $this->assertSame( $num_queries, $wpdb->num_queries );
     }
+
+    /**
+     * @ticket 32762
+     */
+    public function test_it_should_be_possible_to_modify_meta_query_using_pre_get_comments_action() {
+        $comments = $this->factory->comment->create_many( 2, array(
+            'comment_post_ID' => $this->post_id,
+        ) );
+
+        add_comment_meta( $comments[1], 'foo', 'bar' );
+
+        add_action( 'pre_get_comments', array( $this, 'modify_meta_query' ) );
+
+        $q = new WP_Comment_Query( array(
+            'comment_post_ID' => $this->post_id,
+            'fields' => 'ids',
+        ) );
+
+        remove_action( 'pre_get_comments', array( $this, 'modify_meta_query' ) );
+
+        $this->assertEqualSets( array( $comments[1] ), $q->comments );
+    }
+
+    public function modify_meta_query( $q ) {
+        $q->meta_query = new WP_Meta_Query( array(
+            array(
+                'key' => 'foo',
+                'value' => 'bar',
+            ),
+        ) );
+    }
+
+    /**
+     * @ticket 32762
+     */
+    public function test_it_should_be_possible_to_modify_meta_params_using_pre_get_comments_action() {
+        $comments = $this->factory->comment->create_many( 2, array(
+            'comment_post_ID' => $this->post_id,
+        ) );
+
+        add_comment_meta( $comments[1], 'foo', 'bar' );
+
+        add_action( 'pre_get_comments', array( $this, 'modify_meta_params' ) );
+
+        $q = new WP_Comment_Query( array(
+            'comment_post_ID' => $this->post_id,
+            'fields' => 'ids',
+        ) );
+
+        remove_action( 'pre_get_comments', array( $this, 'modify_meta_params' ) );
+
+        $this->assertEqualSets( array( $comments[1] ), $q->comments );
+    }
+
+    public function modify_meta_params( $q ) {
+        $q->query_vars['meta_key'] = 'foo';
+        $q->query_vars['meta_value'] = 'bar';
+    }
 }