<!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>[49256] trunk: Comments: Add a filter for top level comments query arguments 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 { 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/49256">49256</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/49256","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-10-20 20:09:39 +0000 (Tue, 20 Oct 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: Add a filter for top level comments query arguments in `comments_template()`.
Props hellofromTonya, Howdy_McGee, garrett-eclipse, davidbaumwald, thomaslhotta.
Fixes <a href="https://core.trac.wordpress.org/ticket/38074">#38074</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommenttemplatephp">trunk/src/wp-includes/comment-template.php</a></li>
<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 2020-10-20 20:01:04 UTC (rev 49255)
+++ trunk/src/wp-includes/comment-template.php 2020-10-20 20:09:39 UTC (rev 49256)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1434,6 +1434,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $top_level_args['include_unapproved'] = $comment_args['include_unapproved'];
</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">+ /**
+ * Filters the arguments used in the top level comments query.
+ *
+ * @since 5.6.0
+ *
+ * @see WP_Comment_Query::__construct()
+ *
+ * @param array $top_level_args {
+ * The top level query arguments for the comments template.
+ *
+ * @type bool $count Whether to return a comment count.
+ * @type string|array $orderby The field(s) to order by.
+ * @type int $post_id The post ID.
+ * @type string|array $status The comment status to limit results by.
+ * }
+ */
+ $top_level_args = apply_filters( 'comments_template_top_level_query_args', $top_level_args );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $top_level_count = $top_level_query->query( $top_level_args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $comment_args['offset'] = ( ceil( $top_level_count / $per_page ) - 1 ) * $per_page;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1463,7 +1481,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $number Number of comments to fetch.
</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">- $comment_args = apply_filters( 'comments_template_query_args', $comment_args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $comment_args = apply_filters( 'comments_template_query_args', $comment_args );
+
</ins><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></span></pre></div>
<a id="trunktestsphpunittestscommentcommentsTemplatephp"></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/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 2020-10-20 20:01:04 UTC (rev 49255)
+++ trunk/tests/phpunit/tests/comment/commentsTemplate.php 2020-10-20 20:09:39 UTC (rev 49256)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -960,4 +960,124 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $found_cids = array_map( 'intval', $matches[1] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( array( $comment_3 ), $found_cids );
</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 38074
+ * @dataProvider data_comments_template_top_level_query_args
+ *
+ * @param array $expected Array of expected values.
+ * @param array $query_args Args for the 'comments_template_query_args' filter.
+ * @param array $top_level_query_args Args for the 'comments_template_top_level_query_args' filter.
+ */
+ public function test_comments_template_top_level_query_args( $expected, $query_args, $top_level_query_args ) {
+ $now = time();
+ $offset = 0;
+ $p = self::factory()->post->create();
+ $comment_ids = array();
+
+ for ( $num = 1; $num <= 6; $num++ ) {
+ $comment_ids[ $num ] = self::factory()->comment->create(
+ array(
+ 'comment_post_ID' => $p,
+ 'comment_content' => "{$num}",
+ 'comment_date_gmt' => gmdate( 'Y-m-d H:i:s', $now - 100 * $num ),
+ )
+ );
+ add_comment_meta( $comment_ids[ $num ], 'featured', $num > 3 ? '1' : '0' );
+ }
+
+ update_option( 'comment_order', 'asc' );
+ update_option( 'comments_per_page', 3 );
+ update_option( 'page_comments', 1 );
+ update_option( 'default_comments_page', 'newest' );
+
+ add_filter(
+ 'comments_template_query_args',
+ function ( $args ) use ( &$offset, $query_args ) {
+ $offset = $args['offset'];
+
+ return array_merge( $args, $query_args );
+ }
+ );
+
+ if ( ! empty( $top_level_query_args ) ) {
+ add_filter(
+ 'comments_template_top_level_query_args',
+ function ( $args ) use ( $top_level_query_args ) {
+ return array_merge( $args, $top_level_query_args );
+ }
+ );
+ }
+
+ $this->go_to( get_permalink( $p ) );
+
+ $found = get_echo( 'comments_template' );
+ preg_match_all( '/id="comment-([0-9]+)"/', $found, $matches );
+
+ $expected_ids = array();
+ foreach ( $expected['ids'] as $index ) {
+ $expected_ids[] = $comment_ids[ $index ];
+ }
+
+ $this->assertSame( $expected_ids, array_map( 'intval', $matches[1] ) );
+ $this->assertEquals( $expected['offset'], $offset );
+ }
+
+ public function data_comments_template_top_level_query_args() {
+ return array(
+ array(
+ array(
+ 'ids' => array(),
+ 'offset' => 3,
+ ),
+ array(
+ 'meta_key' => 'featured',
+ 'meta_value' => '1',
+ ),
+ array(),
+ ),
+ array(
+ array(
+ 'ids' => array(),
+ 'offset' => 3,
+ ),
+ array(
+ 'order' => 'DESC',
+ 'meta_key' => 'featured',
+ 'meta_value' => '0',
+ ),
+ array(),
+ ),
+ array(
+ array(
+ 'ids' => array( 6, 5, 4 ),
+ 'offset' => 0,
+ ),
+ array(
+ 'meta_key' => 'featured',
+ 'meta_value' => '1',
+ ),
+ array(
+ 'meta_key' => 'featured',
+ 'meta_value' => '1',
+ ),
+ ),
+ array(
+ array(
+ 'ids' => array( 4, 5, 6 ),
+ 'offset' => 0,
+ ),
+ array(
+ 'order' => 'DESC',
+ 'meta_key' => 'featured',
+ 'meta_value' => '1',
+ ),
+ array(
+ 'order' => 'DESC',
+ 'meta_key' => 'featured',
+ 'meta_value' => '1',
+ ),
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>