Changeset 34544

Timestamp:

09/25/2015 02:34:20 PM (9 years ago)

Author:

boonebgorges

Message:

Improve pagination internals in WP_Comment_Query.

WP_Comment_Query will now report the total number of comments matching the
query params (comments_found), as well as the total number of pages required
to display these comments (max_num_pages). Because SQL_CALC_FOUND_ROWS
queries can introduce a lot of overhead in some cases, we disable the feature
by default. Pass no_found_rows=false to WP_Comment_Query to enable the
count. (We use the negative parameter name 'no_found_rows' for parity with
WP_Query.)

Props wonderboymusic, boonebgorges.
See #8071.

Location:

trunk

Files:

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

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

@@ -97 +97 @@
 
     /**
+     * The amount of found comments for the current query.
+     *
+     * @since 4.4.0
+     * @access public
+     * @var int
+     */
+    public $found_comments = 0;
+
+    /**
+     * The number of pages.
+     *
+     * @since 4.4.0
+     * @access public
+     * @var int
+     */
+    public $max_num_pages = 0;
+
+    /**
      * Make private/protected methods readable for backwards compatibility.
      *
@@ -120 +138 @@
      * @since 4.2.0
      * @since 4.4.0 `$parent__in` and `$parent__not_in` were added.
-     * @since 4.4.0 Order by `comment__in` was added. `$update_comment_meta_cache` was added.
+     * @since 4.4.0 Order by `comment__in` was added. `$update_comment_meta_cache` and `$no_found_rows` were added.
      * @access public
      *
@@ -149 +167 @@
      *     @type int          $offset              Number of comments to offset the query. Used to build LIMIT clause.
      *                                             Default 0.
+     *     @type bool         $no_found_rows       Whether to disable the `SQL_CALC_FOUND_ROWS` query.
+     *                                             Default: true.
      *     @type string|array $orderby             Comment status or array of statuses. To use 'meta_value' or
      *                                             'meta_value_num', `$meta_key` must also be defined. To sort by
@@ -204 +224 @@
             'number' => '',
             'offset' => '',
+            'no_found_rows' => true,
             'orderby' => '',
             'order' => 'DESC',
@@ -331 +352 @@
         $comment_ids = array_map( 'intval', $comment_ids );
 
+        $this->comment_count = count( $this->comments );
+
+        if ( $comment_ids && $this->query_vars['number'] && ! $this->query_vars['no_found_rows'] ) {
+            /**
+             * Filter the query used to retrieve found comment count.
+             *
+             * @since 4.4.0
+             *
+             * @param string           $found_comments_query SQL query. Default 'SELECT FOUND_ROWS()'.
+             * @param WP_Comment_Query $comment_query        The `WP_Comment_Query` instance.
+             */
+            $found_comments_query = apply_filters( 'found_comments_query', 'SELECT FOUND_ROWS()', $this );
+            $this->found_comments = (int) $wpdb->get_var( $found_comments_query );
+
+            $this->max_num_pages = ceil( $this->found_comments / $this->query_vars['number'] );
+        }
+
         if ( 'ids' == $this->query_vars['fields'] ) {
             $this->comments = $comment_ids;
@@ -739 +777 @@
         }
 
-        $this->sql_clauses['select']  = "SELECT $fields";
+        $found_rows = '';
+        if ( ! $this->query_vars['no_found_rows'] ) {
+            $found_rows = 'SQL_CALC_FOUND_ROWS';
+        }
+
+        $this->sql_clauses['select']  = "SELECT $found_rows $fields";
         $this->sql_clauses['from']    = "FROM $wpdb->comments $join";
         $this->sql_clauses['groupby'] = $groupby;

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

@@ -1874 +1874 @@
 
     }
+
+    /**
+     * @ticket 8071
+     */
+    public function test_no_found_rows_should_default_to_true() {
+        $comments = $this->factory->comment->create_many( 3, array( 'comment_post_ID' => $this->post_id ) );
+
+        $q = new WP_Comment_Query( array(
+            'post_id' => $this->post_id,
+            'number' => 2,
+        ) );
+
+        $this->assertEquals( 0, $q->found_comments );
+        $this->assertEquals( 0, $q->max_num_pages );
+    }
+
+    /**
+     * @ticket 8071
+     */
+    public function test_should_respect_no_found_rows_true() {
+        $comments = $this->factory->comment->create_many( 3, array( 'comment_post_ID' => $this->post_id ) );
+
+        $q = new WP_Comment_Query( array(
+            'post_id' => $this->post_id,
+            'number' => 2,
+            'no_found_rows' => true,
+        ) );
+
+        $this->assertEquals( 0, $q->found_comments );
+        $this->assertEquals( 0, $q->max_num_pages );
+    }
+
+    /**
+     * @ticket 8071
+     */
+    public function test_should_respect_no_found_rows_false() {
+        $comments = $this->factory->comment->create_many( 3, array( 'comment_post_ID' => $this->post_id ) );
+
+        $q = new WP_Comment_Query( array(
+            'post_id' => $this->post_id,
+            'number' => 2,
+            'no_found_rows' => false,
+        ) );
+
+        $this->assertEquals( 3, $q->found_comments );
+        $this->assertEquals( 2, $q->max_num_pages );
+    }
 }