<!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>[36157] trunk: Ensure that non-default pagination values work in `wp_list_comments()`.</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/36157">36157</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/36157","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>2016-01-03 02:02:59 +0000 (Sun, 03 Jan 2016)</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'>Ensure that non-default pagination values work in `wp_list_comments()`.

Prior to 4.4, it was possible to pass 'page' and 'per_page' values to
`wp_list_comments()` that do not match the corresponding global query vars.
This ability was lost in 4.4 with the refactor of how `comments_template()`
queries for comments; when the main comment query started fetching only the
comments that ought to appear on a page, instead of all of a post's comments,
it became impossible for the comment walker to select comments corresponding to
custom pagination parameters. See <a href="https://core.trac.wordpress.org/ticket/8071">#8071</a>.

We restore the previous behavior by (a) detecting when a 'page' or 'per_page'
parameter has been passed to `wp_list_comments()` that does not match the
corresponding query vars (so that the desired comments will not be found in
`$wp_query`), and if so, then (b) querying for all of the post's comments and
passing them to the comment walker for pagination, as was the case before 4.4.

Props boonebgorges, smerriman.
Fixes <a href="https://core.trac.wordpress.org/ticket/35175">#35175</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestscommentwpListCommentsphp">trunk/tests/phpunit/tests/comment/wpListComments.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescommenttemplatephp"></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/comment-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment-template.php        2016-01-02 15:15:53 UTC (rev 36156)
+++ trunk/src/wp-includes/comment-template.php  2016-01-03 02:02:59 UTC (rev 36157)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1876,6 +1876,27 @@
</span><span class="cx" style="display: block; padding: 0 10px">         */
</span><span class="cx" style="display: block; padding: 0 10px">        $r = apply_filters( 'wp_list_comments_args', $r );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+        /*
+        * If 'page' or 'per_page' has been passed, and does not match what's in $wp_query,
+        * perform a separate comment query and allow Walker_Comment to paginate.
+        */
+       if ( is_singular() && ( $r['page'] || $r['per_page'] ) ) {
+               $current_cpage = get_query_var( 'cpage' );
+               if ( ! $current_cpage ) {
+                       $current_cpage = 'newest' === get_option( 'default_comments_page' ) ? 1 : $wp_query->max_num_comment_pages;
+               }
+
+               $current_per_page = get_query_var( 'comments_per_page' );
+               if ( $r['page'] != $current_cpage || $r['per_page'] != $current_per_page ) {
+                       $comments = get_comments( array(
+                               'post_id' => get_queried_object_id(),
+                               'orderby' => 'comment_date_gmt',
+                               'order' => 'ASC',
+                               'status' => 'all',
+                       ) );
+               }
+       }
+
</ins><span class="cx" style="display: block; padding: 0 10px">         // Figure out what comments we'll be looping through ($_comments)
</span><span class="cx" style="display: block; padding: 0 10px">        if ( null !== $comments ) {
</span><span class="cx" style="display: block; padding: 0 10px">                $comments = (array) $comments;
</span></span></pre></div>
<a id="trunktestsphpunittestscommentwpListCommentsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/comment/wpListComments.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment/wpListComments.php                              (rev 0)
+++ trunk/tests/phpunit/tests/comment/wpListComments.php        2016-01-03 02:02:59 UTC (rev 36157)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,113 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group comment
+ */
+class Tests_Comment_WpListComments extends WP_UnitTestCase {
+       /**
+        * @ticket 35175
+        */
+       public function test_should_respect_page_param() {
+               $p = self::factory()->post->create();
+
+               $comments = array();
+               $now = time();
+               for ( $i = 0; $i <= 5; $i++ ) {
+                       $comments[] = self::factory()->comment->create( array(
+                               'comment_post_ID' => $p,
+                               'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - $i ),
+                               'comment_author' => 'Commenter ' . $i,
+                       ) );
+               }
+
+               update_option( 'page_comments', true );
+               update_option( 'comments_per_page', 2 );
+
+               $this->go_to( get_permalink( $p ) );
+
+               // comments_template() populates $wp_query->comments
+               get_echo( 'comments_template' );
+
+               $found = wp_list_comments( array(
+                       'page' => 2,
+                       'echo' => false,
+               ) );
+
+               preg_match_all( '|id="comment\-([0-9]+)"|', $found, $matches );
+
+               $this->assertEqualSets( array( $comments[2], $comments[3] ), $matches[1] );
+       }
+
+       /**
+        * @ticket 35175
+        */
+       public function test_should_respect_per_page_param() {
+               $p = self::factory()->post->create();
+
+               $comments = array();
+               $now = time();
+               for ( $i = 0; $i <= 5; $i++ ) {
+                       $comments[] = self::factory()->comment->create( array(
+                               'comment_post_ID' => $p,
+                               'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - $i ),
+                               'comment_author' => 'Commenter ' . $i,
+                       ) );
+               }
+
+               update_option( 'page_comments', true );
+               update_option( 'comments_per_page', 2 );
+
+               $this->go_to( get_permalink( $p ) );
+
+               // comments_template() populates $wp_query->comments
+               get_echo( 'comments_template' );
+
+               $found = wp_list_comments( array(
+                       'per_page' => 3,
+                       'echo' => false,
+               ) );
+
+               preg_match_all( '|id="comment\-([0-9]+)"|', $found, $matches );
+
+               $this->assertEqualSets( array( $comments[0], $comments[1], $comments[2] ), $matches[1] );
+       }
+
+       /**
+        * @ticket 35175
+        */
+       public function test_should_respect_reverse_top_level_param() {
+               $p = self::factory()->post->create();
+
+               $comments = array();
+               $now = time();
+               for ( $i = 0; $i <= 5; $i++ ) {
+                       $comments[] = self::factory()->comment->create( array(
+                               'comment_post_ID' => $p,
+                               'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - $i ),
+                               'comment_author' => 'Commenter ' . $i,
+                       ) );
+               }
+
+               update_option( 'page_comments', true );
+               update_option( 'comments_per_page', 2 );
+
+               $this->go_to( get_permalink( $p ) );
+
+               // comments_template() populates $wp_query->comments
+               get_echo( 'comments_template' );
+
+               $found1 = wp_list_comments( array(
+                       'reverse_top_level' => true,
+                       'echo' => false,
+               ) );
+               preg_match_all( '|id="comment\-([0-9]+)"|', $found1, $matches );
+               $this->assertSame( array( $comments[0], $comments[1] ), array_map( 'intval', $matches[1] ) );
+
+               $found2 = wp_list_comments( array(
+                       'reverse_top_level' => false,
+                       'echo' => false,
+               ) );
+               preg_match_all( '|id="comment\-([0-9]+)"|', $found2, $matches );
+               $this->assertSame( array( $comments[1], $comments[0] ), array_map( 'intval', $matches[1] ) );
+       }
+}
</ins></span></pre>
</div>
</div>

</body>
</html>