Ticket #24826: 24826.2.diff

src/wp-includes/comment.php

@@ -220 +220 @@
  *
  * @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.
  */
@@ -265 +265 @@
         public $date_query = false;
 
         /**
+         * Query vars set by the user
+         *
+         * @since  3.1.0
+         * @access public
          * @var array
          */
         public $query_vars;
 
         /**
+         * List of comments
+         *
+         * @since  4.0.0
+         * @access public
          * @var array
          */
         public $comments;
@@ -292 +300 @@
         }
 
         /**
-         * Execute the query
+         * Constructor.
          *
-         * @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.
+         * Sets up the comment query, if parameter is not empty.
+         *
+         * @since  4.2.0
+         * @access public
          *
-         * @param string|array $query_vars {
+         * @param string $query URL query string.
+         * @return WP_Comment_Query
+         */
+        function __construct( $query = '' ) {
+                if ( ! empty( $query ) ) {
+                        $this->query( $query );
+                }
+        }
+
+        /**
+         * Parse a query string and set query type booleans.
+         *
+         * @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.
          *
          *     @type string       $author_email        Comment author email address. Default empty.
@@ -363 +385 @@
          *     @type array        $type__not_in        Exclude comments from a given array of comment types. Default empty.
          *     @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 ) {
-                global $wpdb;
-
+        function parse_query( $query = '' ) {
+                if ( empty( $query ) ) {
+                        $query = $this->query_vars;
+                }
                 $defaults = array(
                         'author_email' => '',
                         'author__in' => '',
@@ -407 +429 @@
                         'date_query' => null, // See WP_Date_Query
                 );
 
+                $this->query_vars = wp_parse_args( $query, $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 $query_vars URL query string.
+         * @return array List of comments.
+         */
+        function query( $query_vars ) {
+                $this->query_vars = wp_parse_args( $query_vars );
+                return $this->get_comments();
+        }
+
+        /**
+         * Get a list of comments.
+         *
+         * @since 4.2.0
+         *
+         * @return array The list of comments.
+         */
+        function get_comments() {
+                global $wpdb;
+
                 $groupby = '';
 
-                $this->query_vars = wp_parse_args( $query_vars, $defaults );
+                $this->parse_query();
 
                 // Parse meta query
                 $this->meta_query = new WP_Meta_Query();
@@ -428 +484 @@
                  */
                 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 be whatever, only use the args defined in the query_vars to compute the key
+                $key = md5( serialize( $this->query_vars)  );
                 $last_changed = wp_cache_get( 'last_changed', 'comment' );
                 if ( ! $last_changed ) {
                         $last_changed = microtime();
@@ -438 +494 @@
                 $cache_key = "get_comments:$key:$last_changed";
 
                 if ( $cache = wp_cache_get( $cache_key, 'comment' ) ) {
+                        $this->comments = $cache;
                         return $cache;
                 }
 
@@ -825 +882 @@
                 $comments = apply_filters_ref_array( 'the_comments', array( $results, &$this ) );
 
                 wp_cache_add( $cache_key, $comments, 'comment' );
+                $this->comments = $comments;
 
                 return $comments;
         }

tests/phpunit/tests/comment/query.php

@@ -1587 +1587 @@
 
                 $this->assertEqualSets( array_merge( $c1, $c3 ), $found );
         }
+
+        /**
+         * @ticket 24826
+         */
+        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() );
+        }
 }