<!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>[34669] trunk: Fix comment_order for single page comment threads.</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/34669">34669</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/34669","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-28 19:29:22 +0000 (Mon, 28 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'>Fix comment_order for single page comment threads.
The old comment pagination logic had a separate block for comment threads that
appeared on a single page. After the refactoring in <a href="https://core.trac.wordpress.org/changeset/34561">[34561]</a>, all comment
pagination logic is unified.
This change ensures that 'comment_order' is respected in all scenarios.
Fixes <a href="https://core.trac.wordpress.org/ticket/8071">#8071</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="#trunktestsphpunittestscommentcommentsTemplatephp">trunk/tests/phpunit/tests/comment/commentsTemplate.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 2015-09-28 19:25:05 UTC (rev 34668)
+++ trunk/src/wp-includes/comment-template.php 2015-09-28 19:29:22 UTC (rev 34669)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1233,57 +1233,54 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $per_page = (int) get_option( 'comments_per_page' );
</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">- $flip_comment_order = $trim_comments_on_page = false;
- if ( $post->comment_count > $per_page ) {
- $comment_args['number'] = $per_page;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * For legacy reasons, higher page numbers always mean more recent comments, regardless of sort order.
+ * Since we don't have full pagination info until after the query, we use some tricks to get the
+ * right comments for the current page.
+ *
+ * Abandon all hope, ye who enter here!
+ */
+ $flip_comment_order = $trim_comments_on_page= false;
+ $comment_args['number'] = $per_page;
+ $page = (int) get_query_var( 'cpage' );
+ if ( 'newest' === get_option( 'default_comments_page' ) ) {
+ if ( $page ) {
+ $comment_args['order'] = 'ASC';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * For legacy reasons, higher page numbers always mean more recent comments, regardless of sort order.
- * Since we don't have full pagination info until after the query, we use some tricks to get the
- * right comments for the current page.
- *
- * Abandon all hope, ye who enter here!
- */
- $page = (int) get_query_var( 'cpage' );
- if ( 'newest' === get_option( 'default_comments_page' ) ) {
- if ( $page ) {
- $comment_args['order'] = 'ASC';
-
- /*
- * We don't have enough data (namely, the total number of comments) to calculate an
- * exact offset. We'll fetch too many comments, and trim them as needed
- * after the query.
- */
- $offset = ( $page - 2 ) * $per_page;
- if ( 0 > $offset ) {
- // `WP_Comment_Query` doesn't support negative offsets.
- $comment_args['offset'] = 0;
- } else {
- $comment_args['offset'] = $offset;
- }
-
- // Fetch double the number of comments we need.
- $comment_args['number'] += $per_page;
- $trim_comments_on_page = true;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * We don't have enough data (namely, the total number of comments) to calculate an
+ * exact offset. We'll fetch too many comments, and trim them as needed
+ * after the query.
+ */
+ $offset = ( $page - 2 ) * $per_page;
+ if ( 0 > $offset ) {
+ // `WP_Comment_Query` doesn't support negative offsets.
+ $comment_args['offset'] = 0;
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $comment_args['order'] = 'DESC';
- $comment_args['offset'] = 0;
- $flip_comment_order = true;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $comment_args['offset'] = $offset;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Fetch double the number of comments we need.
+ $comment_args['number'] += $per_page;
+ $trim_comments_on_page = true;
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $comment_args['order'] = 'ASC';
- if ( $page ) {
- $comment_args['offset'] = ( $page - 1 ) * $per_page;
- } else {
- $comment_args['offset'] = 0;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $comment_args['order'] = 'DESC';
+ $comment_args['offset'] = 0;
+ $flip_comment_order = true;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
+ $comment_args['order'] = 'ASC';
+ if ( $page ) {
+ $comment_args['offset'] = ( $page - 1 ) * $per_page;
+ } else {
+ $comment_args['offset'] = 0;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_query = new WP_Comment_Query( $comment_args );
</span><span class="cx" style="display: block; padding: 0 10px"> $_comments = $comment_query->comments;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Delightful pagination quirk #1: first page of results sometimes needs reordering.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Delightful pagination quirk #1: `wp_list_comments()` expects the order to be wrong, so we make it wrong.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $flip_comment_order ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $_comments = array_reverse( $_comments );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestscommentcommentsTemplatephp"></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/commentsTemplate.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment/commentsTemplate.php (rev 0)
+++ trunk/tests/phpunit/tests/comment/commentsTemplate.php 2015-09-28 19:29:22 UTC (rev 34669)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,288 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group comment
+ *
+ * Testing items that are only testable by grabbing the markup of `comments_template()` from the output buffer.
+ */
+class Tests_Comment_CommentsTemplate extends WP_UnitTestCase {
+ /**
+ * @ticket 8071
+ */
+ public function test_should_respect_comment_order_asc_when_default_comments_page_is_newest() {
+ $now = time();
+ $p = $this->factory->post->create();
+ $comment_1 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '1',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 100 ),
+ ) );
+ $comment_2 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '2',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 200 ),
+ ) );
+
+ update_option( 'comment_order', 'asc' );
+ update_option( 'default_comments_page', 'newest' );
+
+ $this->go_to( get_permalink( $p ) );
+ $found = get_echo( 'comments_template' );
+
+ // Life in the fast lane.
+ $comments = preg_match_all( '/id="comment-([0-9]+)"/', $found, $matches );
+
+ $found_cids = array_map( 'intval', $matches[1] );
+ $this->assertSame( array( $comment_1, $comment_2 ), $found_cids );
+ }
+
+ /**
+ * @ticket 8071
+ */
+ public function test_should_respect_comment_order_desc_when_default_comments_page_is_newest() {
+ $now = time();
+ $p = $this->factory->post->create();
+ $comment_1 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '1',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 100 ),
+ ) );
+ $comment_2 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '2',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 200 ),
+ ) );
+
+ update_option( 'comment_order', 'desc' );
+ update_option( 'default_comments_page', 'newest' );
+
+ $this->go_to( get_permalink( $p ) );
+ $found = get_echo( 'comments_template' );
+
+ // Life in the fast lane.
+ $comments = preg_match_all( '/id="comment-([0-9]+)"/', $found, $matches );
+
+ $found_cids = array_map( 'intval', $matches[1] );
+ $this->assertSame( array( $comment_2, $comment_1 ), $found_cids );
+ }
+
+ /**
+ * @ticket 8071
+ */
+ public function test_should_respect_comment_order_asc_when_default_comments_page_is_oldest() {
+ $now = time();
+ $p = $this->factory->post->create();
+ $comment_1 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '1',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 100 ),
+ ) );
+ $comment_2 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '2',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 200 ),
+ ) );
+
+ update_option( 'comment_order', 'asc' );
+ update_option( 'default_comments_page', 'oldest' );
+
+ $this->go_to( get_permalink( $p ) );
+ $found = get_echo( 'comments_template' );
+
+ // Life in the fast lane.
+ $comments = preg_match_all( '/id="comment-([0-9]+)"/', $found, $matches );
+
+ $found_cids = array_map( 'intval', $matches[1] );
+ $this->assertSame( array( $comment_1, $comment_2 ), $found_cids );
+ }
+
+ /**
+ * @ticket 8071
+ */
+ public function test_should_respect_comment_order_desc_when_default_comments_page_is_oldest() {
+ $now = time();
+ $p = $this->factory->post->create();
+ $comment_1 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '1',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 100 ),
+ ) );
+ $comment_2 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '2',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 200 ),
+ ) );
+
+ update_option( 'comment_order', 'desc' );
+ update_option( 'default_comments_page', 'oldest' );
+
+ $this->go_to( get_permalink( $p ) );
+ $found = get_echo( 'comments_template' );
+
+ // Life in the fast lane.
+ $comments = preg_match_all( '/id="comment-([0-9]+)"/', $found, $matches );
+
+ $found_cids = array_map( 'intval', $matches[1] );
+ $this->assertSame( array( $comment_2, $comment_1 ), $found_cids );
+ }
+
+ /**
+ * @ticket 8071
+ */
+ public function test_should_respect_comment_order_asc_when_default_comments_page_is_newest_on_subsequent_pages() {
+ $now = time();
+ $p = $this->factory->post->create();
+ $comment_1 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '1',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 100 ),
+ ) );
+ $comment_2 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '2',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 200 ),
+ ) );
+ $comment_3 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '3',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 300 ),
+ ) );
+ $comment_4 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '4',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 400 ),
+ ) );
+
+ update_option( 'comment_order', 'asc' );
+ update_option( 'default_comments_page', 'newest' );
+
+ $this->go_to( get_permalink( $p ) . '?cpage=2&comments_per_page=2' );
+ $found = get_echo( 'comments_template' );
+
+ // Life in the fast lane.
+ $comments = preg_match_all( '/id="comment-([0-9]+)"/', $found, $matches );
+
+ $found_cids = array_map( 'intval', $matches[1] );
+ $this->assertSame( array( $comment_3, $comment_4 ), $found_cids );
+ }
+
+ /**
+ * @ticket 8071
+ */
+ public function test_should_respect_comment_order_desc_when_default_comments_page_is_newest_on_subsequent_pages() {
+ $now = time();
+ $p = $this->factory->post->create();
+ $comment_1 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '1',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 100 ),
+ ) );
+ $comment_2 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '2',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 200 ),
+ ) );
+ $comment_3 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '3',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 300 ),
+ ) );
+ $comment_4 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '4',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 400 ),
+ ) );
+
+ update_option( 'comment_order', 'desc' );
+ update_option( 'default_comments_page', 'newest' );
+
+ $this->go_to( get_permalink( $p ) . '?cpage=2&comments_per_page=2' );
+ $found = get_echo( 'comments_template' );
+
+ // Life in the fast lane.
+ $comments = 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 );
+ }
+
+ /**
+ * @ticket 8071
+ */
+ public function test_should_respect_comment_order_asc_when_default_comments_page_is_oldest_on_subsequent_pages() {
+ $now = time();
+ $p = $this->factory->post->create();
+ $comment_1 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '1',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 100 ),
+ ) );
+ $comment_2 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '2',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 200 ),
+ ) );
+ $comment_3 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '3',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 300 ),
+ ) );
+ $comment_4 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '4',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 400 ),
+ ) );
+
+ update_option( 'comment_order', 'asc' );
+ update_option( 'default_comments_page', 'oldest' );
+
+ $this->go_to( get_permalink( $p ) . '?cpage=2&comments_per_page=2' );
+ $found = get_echo( 'comments_template' );
+
+ // Life in the fast lane.
+ $comments = preg_match_all( '/id="comment-([0-9]+)"/', $found, $matches );
+
+ $found_cids = array_map( 'intval', $matches[1] );
+ $this->assertSame( array( $comment_1, $comment_2 ), $found_cids );
+ }
+
+ /**
+ * @ticket 8071
+ */
+ public function test_should_respect_comment_order_desc_when_default_comments_page_is_oldest_on_subsequent_pages() {
+ $now = time();
+ $p = $this->factory->post->create();
+ $comment_1 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '1',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 100 ),
+ ) );
+ $comment_2 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '2',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 200 ),
+ ) );
+ $comment_3 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '3',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 300 ),
+ ) );
+ $comment_4 = $this->factory->comment->create( array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => '4',
+ 'comment_post_gmt' => date( 'Y-m-d H:i:s', $now - 400 ),
+ ) );
+
+ update_option( 'comment_order', 'desc' );
+ update_option( 'default_comments_page', 'oldest' );
+
+ $this->go_to( get_permalink( $p ) . '?cpage=2&comments_per_page=2' );
+ $found = get_echo( 'comments_template' );
+
+ // Life in the fast lane.
+ $comments = preg_match_all( '/id="comment-([0-9]+)"/', $found, $matches );
+
+ $found_cids = array_map( 'intval', $matches[1] );
+ $this->assertSame( array( $comment_2, $comment_1 ), $found_cids );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>