Changeset 31793

Timestamp:

03/16/2015 02:23:33 PM (10 years ago)

Author:

boonebgorges

Message:

Improve method consistency in WP_Comment_Query.

• Introduce a __construct() method, which can accept an array of query vars.
• Move query logic out of query() method and into a new get_comments() method.
• Ensure that $this->comments is set whenever get_comments() returns a value.
• Introduce a parse_query() method, where query vars are parsed with default values and the 'parse_comment_query' action is fired.

These changes bring WP_Comment_Query syntax closer to that of WP_Query.

Props westonruter, morganestes, boonebgorges.
Fixes #24826.

Location:

trunk

Files:

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

trunk/src/wp-includes/comment.php

@@ -221 +221 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param string|array $args Optional. Array or string of arguments. See {@see WP_Comment_Query::query()}
+ * @param string|array $args Optional. Array or string of arguments. See {@see WP_Comment_Query::parse_query()}
  *                           for information on accepted arguments. Default empty.
  * @return int|array List of comments or number of found comments if `$count` argument is true.
@@ -266 +266 @@
 
     /**
+     * Query vars set by the user.
+     *
+     * @since 3.1.0
+     * @access public
      * @var array
      */
@@ -271 +275 @@
 
     /**
+     * Default values for query vars.
+     *
+     * @since 4.2.0
+     * @access public
+     * @var array
+     */
+    public $query_var_defaults;
+
+    /**
+     * List of comments located by the query.
+     *
+     * @since 4.0.0
+     * @access public
      * @var array
      */
@@ -293 +310 @@
 
     /**
-     * Execute the query
-     *
-     * @since 3.1.0
-     * @since 4.1.0 Introduced 'comment__in', 'comment__not_in', 'post_author__in',
-     *              'post_author__not_in', 'author__in', 'author__not_in', 'post__in',
-     *              'post__not_in', 'include_unapproved', 'type__in', and 'type__not_in'
-     *              arguments to $query_vars.
-     *
-     * @param string|array $query_vars {
+     * Constructor.
+     *
+     * Sets up the comment query, based on the query vars passed.
+     *
+     * @since  4.2.0
+     * @access public
+     *
+     * @param string $query URL query string.
+     * @return WP_Comment_Query
+     */
+    public function __construct( $query = '' ) {
+        $this->query_var_defaults = array(
+            'author_email' => '',
+            'author__in' => '',
+            'author__not_in' => '',
+            'include_unapproved' => '',
+            'fields' => '',
+            'ID' => '',
+            'comment__in' => '',
+            'comment__not_in' => '',
+            'karma' => '',
+            'number' => '',
+            'offset' => '',
+            'orderby' => '',
+            'order' => 'DESC',
+            'parent' => '',
+            'post_author__in' => '',
+            'post_author__not_in' => '',
+            'post_ID' => '',
+            'post_id' => 0,
+            'post__in' => '',
+            'post__not_in' => '',
+            'post_author' => '',
+            'post_name' => '',
+            'post_parent' => '',
+            'post_status' => '',
+            'post_type' => '',
+            'status' => 'all',
+            'type' => '',
+            'type__in' => '',
+            'type__not_in' => '',
+            'user_id' => '',
+            'search' => '',
+            'count' => false,
+            'meta_key' => '',
+            'meta_value' => '',
+            'meta_query' => '',
+            'date_query' => null, // See WP_Date_Query
+        );
+
+        if ( ! empty( $query ) ) {
+            $this->query( $query );
+        }
+    }
+
+    /**
+     * Parse arguments passed to the comment query with default query parameters.
+     *
+     * @since  4.2.0 Extracted from {@link WP_Comment_Query::query()}.
+     * @access public
+     *
+     * @param string|array $query {
      *     Optional. Array or query string of comment query parameters.
      *
@@ -364 +434 @@
      *     @type int          $user_id             Include comments for a specific user ID. Default empty.
      * }
-     * @return int|array Array of comments or number of found comments if `$count` is set to true.
-     */
-    public function query( $query_vars ) {
+     */
+    public function parse_query( $query = '' ) {
+        if ( empty( $query ) ) {
+            $query = $this->query_vars;
+        }
+
+        $this->query_vars = wp_parse_args( $query, $this->query_var_defaults );
+        do_action_ref_array( 'parse_comment_query', array( &$this ) );
+    }
+
+    /**
+     * Sets up the WordPress query for retrieving comments.
+     *
+     * @since 3.1.0
+     * @since 4.1.0 Introduced 'comment__in', 'comment__not_in', 'post_author__in',
+     *              'post_author__not_in', 'author__in', 'author__not_in', 'post__in',
+     *              'post__not_in', 'include_unapproved', 'type__in', and 'type__not_in'
+     *              arguments to $query_vars.
+     * @since 4.2.0 Moved parsing to {@link WP_Comment_Query::parse_query()}.
+     * @access public
+     *
+     * @param string|array $query Array or URL query string of parameters.
+     * @return array List of comments.
+     */
+    public function query( $query ) {
+        $this->query_vars = wp_parse_args( $query );
+        return $this->get_comments();
+    }
+
+    /**
+     * Get a list of comments matching the query vars.
+     *
+     * @since 4.2.0
+     * @access public
+     *
+     * @return array The list of comments.
+     */
+    public function get_comments() {
         global $wpdb;
 
-        $defaults = array(
-            'author_email' => '',
-            'author__in' => '',
-            'author__not_in' => '',
-            'include_unapproved' => '',
-            'fields' => '',
-            'ID' => '',
-            'comment__in' => '',
-            'comment__not_in' => '',
-            'karma' => '',
-            'number' => '',
-            'offset' => '',
-            'orderby' => '',
-            'order' => 'DESC',
-            'parent' => '',
-            'post_author__in' => '',
-            'post_author__not_in' => '',
-            'post_ID' => '',
-            'post_id' => 0,
-            'post__in' => '',
-            'post__not_in' => '',
-            'post_author' => '',
-            'post_name' => '',
-            'post_parent' => '',
-            'post_status' => '',
-            'post_type' => '',
-            'status' => 'all',
-            'type' => '',
-            'type__in' => '',
-            'type__not_in' => '',
-            'user_id' => '',
-            'search' => '',
-            'count' => false,
-            'meta_key' => '',
-            'meta_value' => '',
-            'meta_query' => '',
-            'date_query' => null, // See WP_Date_Query
-        );
-
         $groupby = '';
 
-        $this->query_vars = wp_parse_args( $query_vars, $defaults );
+        $this->parse_query();
 
         // Parse meta query
@@ -429 +495 @@
         do_action_ref_array( 'pre_get_comments', array( &$this ) );
 
-        // $args can be whatever, only use the args defined in defaults to compute the key
-        $key = md5( serialize( wp_array_slice_assoc( $this->query_vars, array_keys( $defaults ) ) )  );
+        // $args can include anything. Only use the args defined in the query_var_defaults to compute the key.
+        $key = md5( serialize( wp_array_slice_assoc( $this->query_vars, array_keys( $this->query_var_defaults ) ) ) );
         $last_changed = wp_cache_get( 'last_changed', 'comment' );
         if ( ! $last_changed ) {
@@ -439 +505 @@
 
         if ( $cache = wp_cache_get( $cache_key, 'comment' ) ) {
-            return $cache;
+            $this->comments = $cache;
+            return $this->comments;
         }
 
@@ -827 +894 @@
         wp_cache_add( $cache_key, $comments, 'comment' );
 
-        return $comments;
+        $this->comments = $comments;
+        return $this->comments;
     }
 

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

@@ -1588 +1588 @@
         $this->assertEqualSets( array_merge( $c1, $c3 ), $found );
     }
+
+    /**
+     * @ticket 24826
+     */
+    public function test_comment_query_object() {
+        $comment_id = $this->factory->comment->create();
+
+        $query1 = new WP_Comment_Query();
+        $this->assertNull( $query1->query_vars );
+        $this->assertEmpty( $query1->comments );
+        $comments = $query1->query( array( 'status' => 'all' ) );
+        $this->assertInternalType( 'array', $query1->query_vars );
+        $this->assertNotEmpty( $query1->comments );
+        $this->assertInternalType( 'array', $query1->comments );
+
+        $query2 = new WP_Comment_Query( array( 'status' => 'all' ) );
+        $this->assertNotEmpty( $query2->query_vars );
+        $this->assertNotEmpty( $query2->comments );
+        $this->assertEquals( $query2->comments, $query1->get_comments() );
+    }
+
+    /**
+     * @ticket 22400
+     */
+    public function test_comment_cache_key_should_ignore_custom_params() {
+        global $wpdb;
+
+        $p = $this->factory->post->create();
+        $c = $this->factory->comment->create( array( 'comment_post_ID' => $p ) );
+
+        $q1 = new WP_Comment_Query();
+        $q1->query( array(
+            'post_id' => $p,
+        ) );
+
+        $num_queries = $wpdb->num_queries;
+
+        $q2 = new WP_Comment_Query();
+        $q2->query( array(
+            'post_id' => $p,
+            'foo' => 'bar',
+        ) );
+
+        $this->assertSame( $num_queries, $wpdb->num_queries );
+    }
 }