<!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>[48133] trunk: Comments: Ensure the proper comment count and pages for unapproved 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 { white-space: pre-line; 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/48133">48133</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/48133","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>whyisjake</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-06-23 05:22:39 +0000 (Tue, 23 Jun 2020)</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'>Comments: Ensure the proper comment count and pages for unapproved comments.
Previiously, unapproved comments can alter the comment count, returning incorrect page numbers.
Fixes <a href="https://core.trac.wordpress.org/ticket/8973">#8973</a>.
Props GregMulhauser, dd32, ryan, mrmist, hakre, solarissmoke, billerickson, ericlewis, SergeyBiryukov, chriscct7, dossy, lukecavanagh, renggo888, jdorner, matjack1, pento, audrasjb, imath, davidbaumwald, whyisjake. </pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>
<li><a href="#trunktestsphpunittestscommentgetPageOfCommentphp">trunk/tests/phpunit/tests/comment/getPageOfComment.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 2020-06-23 05:05:57 UTC (rev 48132)
+++ trunk/src/wp-includes/comment-template.php 2020-06-23 05:22:39 UTC (rev 48133)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1330,6 +1330,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Will not try to get the comments if the post has none.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.5.0 Removed the need to use the $user_ID global.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Query $wp_query WordPress Query object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Post $post Global post object.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1337,7 +1338,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global int $id
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Comment $comment Global comment object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @global string $user_login
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global int $user_ID
</del><span class="cx" style="display: block; padding: 0 10px"> * @global string $user_identity
</span><span class="cx" style="display: block; padding: 0 10px"> * @global bool $overridden_cpage
</span><span class="cx" style="display: block; padding: 0 10px"> * @global bool $withcomments
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1347,7 +1347,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function comments_template( $file = '/comments.php', $separate_comments = false ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_ID, $user_identity, $overridden_cpage;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_identity, $overridden_cpage;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! ( is_single() || is_page() || $withcomments ) || empty( $post ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1396,14 +1396,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_args['hierarchical'] = false;
</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">- if ( $user_ID ) {
- $comment_args['include_unapproved'] = array( $user_ID );
- } else {
- $unapproved_email = wp_get_unapproved_comment_author_email();
-
- if ( $unapproved_email ) {
- $comment_args['include_unapproved'] = array( $unapproved_email );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $include_unapproved = wp_get_include_unapproved_comments_argument();
+ if ( $include_unapproved ) {
+ $comment_args['include_unapproved'] = $include_unapproved;
</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"> $per_page = 0;
</span></span></pre></div>
<a id="trunksrcwpincludescommentphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment.php 2020-06-23 05:05:57 UTC (rev 48132)
+++ trunk/src/wp-includes/comment.php 2020-06-23 05:22:39 UTC (rev 48133)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1132,6 +1132,36 @@
</span><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">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $include_unapproved = wp_get_include_unapproved_comments_argument();
+ if ( $include_unapproved ) {
+ $comment_args['include_unapproved'] = $include_unapproved;
+ }
+
+ /**
+ * Filters the arguments used to query comments in get_page_of_comment().
+ *
+ * @since 5.5.0
+ *
+ * @see WP_Comment_Query::__construct()
+ *
+ * @param array $comment_args {
+ * Array of WP_Comment_Query arguments.
+ *
+ * @type string $type Limit paginated comments to those matching a given type. Accepts 'comment',
+ * 'trackback', 'pingback', 'pings' (trackbacks and pingbacks), or 'all'.
+ * Default is 'all'.
+ * @type int $post_id ID of the post.
+ * @type string $fields Comment fields to return.
+ * @type bool $count Whether to return a comment count (true) or array of
+ * comment objects (false)
+ * @type string $status Comment status.
+ * @type int $parent Parent ID of comment to retrieve children of.
+ * @type array $date_query Date query clauses to limit comments by. See WP_Date_Query.
+ * @type array $include_unapproved Array of IDs or email addresses whose unapproved comments
+ * will be included in paginated comments.
+ * }
+ */
+ $comment_args = apply_filters( 'get_page_of_comment_query_args', $comment_args );
</ins><span class="cx" style="display: block; padding: 0 10px"> $comment_query = new WP_Comment_Query();
</span><span class="cx" style="display: block; padding: 0 10px"> $older_comment_count = $comment_query->query( $comment_args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1897,6 +1927,33 @@
</span><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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Get include unapproved comments query argument.
+ *
+ * Used to include unapproved comments of currrent commenters to
+ * keep them informed their comments were successfully saved.
+ *
+ * @since 5.5.0
+ *
+ * @return array The unapproved comments query argument.
+ */
+function wp_get_include_unapproved_comments_argument() {
+ $user_id = get_current_user_id();
+ $include_unapproved = array();
+
+ if ( $user_id ) {
+ $include_unapproved = array( $user_id );
+ } else {
+ $unapproved_email = wp_get_unapproved_comment_author_email();
+
+ if ( $unapproved_email ) {
+ $include_unapproved = array( $unapproved_email );
+ }
+ }
+
+ return $include_unapproved;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Inserts a comment into the database.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span></span></pre></div>
<a id="trunktestsphpunittestscommentgetPageOfCommentphp"></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/getPageOfComment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment/getPageOfComment.php 2020-06-23 05:05:57 UTC (rev 48132)
+++ trunk/tests/phpunit/tests/comment/getPageOfComment.php 2020-06-23 05:22:39 UTC (rev 48133)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -439,4 +439,111 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 2, get_page_of_comment( $c3 ) );
</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 8973
+ */
+ public function test_page_number_when_unapproved_comments_are_included_for_current_commenter() {
+ $post = self::factory()->post->create();
+ $comment_args = array(
+ 'comment_post_ID' => $post,
+ 'comment_approved' => 0,
+ 'comment_author_email' => 'foo@bar.test',
+ 'comment_author' => 'Foo',
+ 'comment_author_url' => 'https://bar.test',
+ );
+
+ for ( $i = 1; $i < 4; $i++ ) {
+ self::factory()->comment->create(
+ array_merge(
+ $comment_args,
+ array(
+ 'comment_date_gmt' => gmdate( 'Y-m-d H:i:s', time() - ( $i * 1000 ) ),
+ )
+ )
+ );
+ }
+
+ $new_unapproved = self::factory()->comment->create(
+ $comment_args
+ );
+
+ add_filter( 'wp_get_current_commenter', array( $this, 'get_current_commenter' ) );
+
+ $page = get_page_of_comment( $new_unapproved, array( 'per_page' => 3 ) );
+ $comments = get_comments(
+ array(
+ 'number' => 3,
+ 'paged' => $page,
+ 'post_id' => $post,
+ 'status' => 'approve',
+ 'include_unapproved' => array( 'foo@bar.test' ),
+ 'orderby' => 'comment_date_gmt',
+ 'order' => 'ASC',
+ )
+ );
+
+ remove_filter( 'wp_get_current_commenter', array( $this, 'get_current_commenter' ) );
+
+ $this->assertContains( $new_unapproved, wp_list_pluck( $comments, 'comment_ID' ) );
+ }
+
+ /**
+ * @ticket 8973
+ */
+ public function test_page_number_when_unapproved_comments_are_included_for_current_user() {
+ $current_user = get_current_user_id();
+ $post = self::factory()->post->create();
+ $user = self::factory()->user->create_and_get();
+ $comment_args = array(
+ 'comment_post_ID' => $post,
+ 'comment_approved' => 0,
+ 'comment_author_email' => $user->user_email,
+ 'comment_author' => $user->display_name,
+ 'comment_author_url' => $user->user_url,
+ 'user_id' => $user->ID,
+ );
+
+ for ( $i = 1; $i < 4; $i++ ) {
+ self::factory()->comment->create(
+ array_merge(
+ $comment_args,
+ array(
+ 'comment_date_gmt' => gmdate( 'Y-m-d H:i:s', time() - ( $i * 1000 ) ),
+ )
+ )
+ );
+ }
+
+ $new_unapproved = self::factory()->comment->create(
+ $comment_args
+ );
+
+ wp_set_current_user( $user->ID );
+
+ $page = get_page_of_comment( $new_unapproved, array( 'per_page' => 3 ) );
+ $comments = get_comments(
+ array(
+ 'number' => 3,
+ 'paged' => $page,
+ 'post_id' => $post,
+ 'status' => 'approve',
+ 'include_unapproved' => array( $user->ID ),
+ 'orderby' => 'comment_date_gmt',
+ 'order' => 'ASC',
+ )
+ );
+
+ $this->assertContains( $new_unapproved, wp_list_pluck( $comments, 'comment_ID' ) );
+
+ wp_set_current_user( $current_user );
+ }
+
+ public function get_current_commenter() {
+ return array(
+ 'comment_author_email' => 'foo@bar.test',
+ 'comment_author' => 'Foo',
+ 'comment_author_url' => 'https://bar.test',
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>