<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[34544] trunk: Improve pagination internals in `WP_Comment_Query`.</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/34544">34544</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/34544","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-25 14:34:20 +0000 (Fri, 25 Sep 2015)</dd>
</dl>

<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/8071">#8071</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpcommentqueryphp">trunk/src/wp-includes/class-wp-comment-query.php</a></li>
<li><a href="#trunktestsphpunittestscommentqueryphp">trunk/tests/phpunit/tests/comment/query.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpcommentqueryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-comment-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-comment-query.php  2015-09-25 14:28:23 UTC (rev 34543)
+++ trunk/src/wp-includes/class-wp-comment-query.php    2015-09-25 14:34:20 UTC (rev 34544)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,6 +96,24 @@
</span><span class="cx" style="display: block; padding: 0 10px">        public $comments;
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         * 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;
+
+       /**
</ins><span class="cx" style="display: block; padding: 0 10px">          * Make private/protected methods readable for backwards compatibility.
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 4.0.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,7 +137,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 4.2.0
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 4.4.0 `$parent__in` and `$parent__not_in` were added.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @since 4.4.0 Order by `comment__in` was added. `$update_comment_meta_cache` was added.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @since 4.4.0 Order by `comment__in` was added. `$update_comment_meta_cache` and `$no_found_rows` were added.
</ins><span class="cx" style="display: block; padding: 0 10px">          * @access public
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @param string|array $query {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -148,6 +166,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">         *     @type int          $number              Maximum number of comments to retrieve. Default null (no limit).
</span><span class="cx" style="display: block; padding: 0 10px">         *     @type int          $offset              Number of comments to offset the query. Used to build LIMIT clause.
</span><span class="cx" style="display: block; padding: 0 10px">         *                                             Default 0.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         *     @type bool         $no_found_rows       Whether to disable the `SQL_CALC_FOUND_ROWS` query.
+        *                                             Default: true.
</ins><span class="cx" style="display: block; padding: 0 10px">          *     @type string|array $orderby             Comment status or array of statuses. To use 'meta_value' or
</span><span class="cx" style="display: block; padding: 0 10px">         *                                             'meta_value_num', `$meta_key` must also be defined. To sort by
</span><span class="cx" style="display: block; padding: 0 10px">         *                                             a specific `$meta_query` clause, use that clause's array key.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -203,6 +223,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">                        'karma' => '',
</span><span class="cx" style="display: block; padding: 0 10px">                        'number' => '',
</span><span class="cx" style="display: block; padding: 0 10px">                        'offset' => '',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                        'no_found_rows' => true,
</ins><span class="cx" style="display: block; padding: 0 10px">                         'orderby' => '',
</span><span class="cx" style="display: block; padding: 0 10px">                        'order' => 'DESC',
</span><span class="cx" style="display: block; padding: 0 10px">                        'parent' => '',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -330,6 +351,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">                $comment_ids = array_map( 'intval', $comment_ids );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+                $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'] );
+               }
+
</ins><span class="cx" style="display: block; padding: 0 10px">                 if ( 'ids' == $this->query_vars['fields'] ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        $this->comments = $comment_ids;
</span><span class="cx" style="display: block; padding: 0 10px">                        return $this->comments;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -738,7 +776,12 @@
</span><span class="cx" style="display: block; padding: 0 10px">                        $orderby = "ORDER BY $orderby";
</span><span class="cx" style="display: block; padding: 0 10px">                }
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                $this->sql_clauses['select']  = "SELECT $fields";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         $found_rows = '';
+               if ( ! $this->query_vars['no_found_rows'] ) {
+                       $found_rows = 'SQL_CALC_FOUND_ROWS';
+               }
+
+               $this->sql_clauses['select']  = "SELECT $found_rows $fields";
</ins><span class="cx" style="display: block; padding: 0 10px">                 $this->sql_clauses['from']    = "FROM $wpdb->comments $join";
</span><span class="cx" style="display: block; padding: 0 10px">                $this->sql_clauses['groupby'] = $groupby;
</span><span class="cx" style="display: block; padding: 0 10px">                $this->sql_clauses['orderby'] = $orderby;
</span></span></pre></div>
<a id="trunktestsphpunittestscommentqueryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/comment/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment/query.php       2015-09-25 14:28:23 UTC (rev 34543)
+++ trunk/tests/phpunit/tests/comment/query.php 2015-09-25 14:34:20 UTC (rev 34544)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1873,4 +1873,51 @@
</span><span class="cx" style="display: block; padding: 0 10px">                $this->assertEquals( array( $c2, $c3 ), $ids->comments );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+       /**
+        * @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 );
+       }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>

</body>
</html>