<!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>[36041] branches/4.4: Respect approval status when determining comment page count in `comments_template()`.</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/36041">36041</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/36041","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-12-21 03:10:45 +0000 (Mon, 21 Dec 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'>Respect approval status when determining comment page count in `comments_template()`.
Since 4.4, when fetching the first page of comments and the 'newest' comments
are set to display first, `comments_template()` must perform arithmetic to
determine which comments to show. See <a href="https://core.trac.wordpress.org/ticket/8071">#8071</a>. This arithmetic requires the
total comment count for the current post, which is calculated with a separate
`WP_Comment_Query`. This secondary comment query did not properly account for
non-approved comment statuses; all unapproved comments should be part of the
comment count for admins, and individual users should have their own
unapproved comments included in the count. As a result, `comments_template()`
was, in some cases, being fooled into thinking that a post had fewer comments
available for pagination than it actually had, which resulted in empty pages
of comments.
We correct this problem by mirroring 'status' and 'include_unapproved' params
of the main comment query within the secondary query used to calculate pagination.
Merges <a href="https://core.trac.wordpress.org/changeset/36040">[36040]</a> to the 4.4 branch.
Fixes <a href="https://core.trac.wordpress.org/ticket/35068">#35068</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches44srcwpincludescommenttemplatephp">branches/4.4/src/wp-includes/comment-template.php</a></li>
<li><a href="#branches44testsphpunittestscommentcommentsTemplatephp">branches/4.4/tests/phpunit/tests/comment/commentsTemplate.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches44">branches/4.4/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/4.4
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/4.4 2015-12-21 03:06:41 UTC (rev 36040)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/4.4 2015-12-21 03:10:45 UTC (rev 36041)
</ins><a id="branches44"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/4.4</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.1:18031
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.3:20543
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:18512,35802,35823,35825-35826,35829,35832-35834,35837,35839,35850,35931,35933,35944,36003,36005,36038
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:18512,35802,35823,35825-35826,35829,35832-35834,35837,35839,35850,35931,35933,35944,36003,36005,36038,36040
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches44srcwpincludescommenttemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.4/src/wp-includes/comment-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.4/src/wp-includes/comment-template.php 2015-12-21 03:06:41 UTC (rev 36040)
+++ branches/4.4/src/wp-includes/comment-template.php 2015-12-21 03:10:45 UTC (rev 36041)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1313,13 +1313,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> // If fetching the first page of 'newest', we need a top-level comment count.
</span><span class="cx" style="display: block; padding: 0 10px"> $top_level_query = new WP_Comment_Query();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $top_level_count = $top_level_query->query( array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $top_level_args = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'count' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'orderby' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_id' => $post->ID,
</span><span class="cx" style="display: block; padding: 0 10px"> 'parent' => 0,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'status' => 'approve',
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $comment_args['include_unapproved'] ) ) {
+ $top_level_args['include_unapproved'] = $comment_args['include_unapproved'];
+ }
+
+ $top_level_count = $top_level_query->query( $top_level_args );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $comment_args['offset'] = ( ceil( $top_level_count / $per_page ) - 1 ) * $per_page;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="branches44testsphpunittestscommentcommentsTemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.4/tests/phpunit/tests/comment/commentsTemplate.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.4/tests/phpunit/tests/comment/commentsTemplate.php 2015-12-21 03:06:41 UTC (rev 36040)
+++ branches/4.4/tests/phpunit/tests/comment/commentsTemplate.php 2015-12-21 03:10:45 UTC (rev 36041)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -573,4 +573,120 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( 'cpage=1', $m );
</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 35068
+ */
+ public function test_query_offset_should_not_include_unapproved_comments() {
+ $now = time();
+ $p = self::factory()->post->create();
+ $comment_1 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '1',
+ 'comment_approved' => '0',
+ 'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 100 ),
+ ) );
+ $comment_2 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '2',
+ 'comment_approved' => '0',
+ 'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 200 ),
+ ) );
+ $comment_3 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '3',
+ 'comment_approved' => '0',
+ 'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 300 ),
+ ) );
+ $comment_4 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '4',
+ 'comment_approved' => '1',
+ 'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 400 ),
+ ) );
+
+ update_option( 'comment_order', 'asc' );
+ update_option( 'default_comments_page', 'newest' );
+ update_option( 'page_comments', 1 );
+ update_option( 'comments_per_page', 2 );
+
+ $this->go_to( get_permalink( $p ) );
+ $found = get_echo( 'comments_template' );
+
+ // Find the found comments in the markup.
+ preg_match_all( '|id="comment-([0-9]+)|', $found, $matches );
+
+ $found_cids = array_map( 'intval', $matches[1] );
+ $this->assertSame( array( $comment_4 ), $found_cids );
+ }
+
+ /**
+ * @ticket 35068
+ */
+ public function test_query_offset_should_include_unapproved_comments() {
+ $comment_author_email = 'foo@example.com';
+
+ $now = time();
+ $p = self::factory()->post->create();
+ $comment_1 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '1',
+ 'comment_approved' => '0',
+ 'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 100 ),
+ ) );
+ $comment_2 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '2',
+ 'comment_approved' => '0',
+ 'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 200 ),
+ ) );
+ $comment_3 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '3',
+ 'comment_approved' => '0',
+ 'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 100 ),
+ 'comment_author_email' => $comment_author_email,
+ ) );
+ $comment_4 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '4',
+ 'comment_approved' => '0',
+ 'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 200 ),
+ 'comment_author_email' => $comment_author_email,
+ ) );
+ $comment_5 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '5',
+ 'comment_approved' => '0',
+ 'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 300 ),
+ 'comment_author_email' => $comment_author_email,
+ ) );
+ $comment_6 = self::factory()->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '6',
+ 'comment_approved' => '1',
+ 'comment_date_gmt' => date( 'Y-m-d H:i:s', $now - 400 ),
+ ) );
+
+ update_option( 'comment_order', 'asc' );
+ update_option( 'default_comments_page', 'newest' );
+ update_option( 'page_comments', 1 );
+ update_option( 'comments_per_page', 2 );
+
+ add_filter( 'wp_get_current_commenter', array( $this, 'fake_current_commenter' ) );
+ $this->go_to( get_permalink( $p ) );
+ $found = get_echo( 'comments_template' );
+ remove_filter( 'wp_get_current_commenter', array( $this, 'fake_current_commenter' ) );
+
+ // Find the found comments in the markup.
+ preg_match_all( '|id="comment-([0-9]+)|', $found, $matches );
+
+ $found_cids = array_map( 'intval', $matches[1] );
+ $this->assertSame( array( $comment_4, $comment_3 ), $found_cids );
+ }
+
+ public function fake_current_commenter( $commenter ) {
+ $commenter['comment_author_email'] = 'foo@example.com';
+ return $commenter;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>