sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve pagination internals in WP_Comment_Query.

Browse Source 
`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.

git-svn-id: https://develop.svn.wordpress.org/trunk@34544 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Boone Gorges 2015-09-25 14:34:20 +00:00
parent 03515ca82d
commit 8e955c4805
2 changed files with 92 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
src/wp-includes/class-wp-comment-query.php
View File

@ -95,6 +95,24 @@ class WP_Comment_Query {
*/
public $comments;
/**
* 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.
*
@ -119,7 +137,7 @@ class WP_Comment_Query {
*
* @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
*
* @param string|array $query {
@ -148,6 +166,8 @@ class WP_Comment_Query {
* @type int $number Maximum number of comments to retrieve. Default null (no limit).
* @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
* a specific `$meta_query` clause, use that clause's array key.
@ -203,6 +223,7 @@ class WP_Comment_Query {
'karma' => '',
'number' => '',
'offset' => '',
'no_found_rows' => true,
'orderby' => '',
'order' => 'DESC',
'parent' => '',
@ -330,6 +351,23 @@ class WP_Comment_Query {
$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;
return $this->comments;
@ -738,7 +776,12 @@ class WP_Comment_Query {
$orderby = "ORDER BY $orderby";
}
$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;
$this->sql_clauses['orderby'] = $orderby;

47
tests/phpunit/tests/comment/query.php
View File

@ -1873,4 +1873,51 @@ class Tests_Comment_Query extends WP_UnitTestCase {
$this->assertEquals( array( $c2, $c3 ), $ids->comments );
}
/**
* @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 );
}
}