<!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>[40978] trunk: Introduce `$comment_count` param for `WP_Query`.</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/40978">40978</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/40978","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>2017-07-01 11:24:26 +0000 (Sat, 01 Jul 2017)</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'>Introduce `$comment_count` param for `WP_Query`.
This parameter allows querying for posts with a specific value of
`comment_count`. It is also possible to query for posts that match
a `comment_count` comparison by passing an array with 'value' and
'compare' operators (eg `array( 'compare' => '>', 'value' => 5 )`).
Props ramon fincken.
Fixes <a href="https://core.trac.wordpress.org/ticket/28399">#28399</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpqueryphp">trunk/src/wp-includes/class-wp-query.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsquerycommentCountphp">trunk/tests/phpunit/tests/query/commentCount.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpqueryphp"></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/class-wp-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-query.php 2017-07-01 05:18:57 UTC (rev 40977)
+++ trunk/src/wp-includes/class-wp-query.php 2017-07-01 11:24:26 UTC (rev 40978)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -641,6 +641,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Introduced the `$comment_status` and `$ping_status` parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> * Introduced `RAND(x)` syntax for `$orderby`, which allows an integer seed value to random sorts.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.0 Added 'post_name__in' support for `$orderby`. Introduced the `$lazy_load_term_meta` argument.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.9.0 Introduced the `$comment_count` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $query {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -657,6 +658,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $category__in An array of category IDs (OR in, no children).
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $category__not_in An array of category IDs (NOT in).
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $category_name Use category slug (not name, this or any children).
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array|int $comment_count Filter results by comment count. Provide an integer to match
+ * comment count exactly. Provide an array with integer 'value'
+ * and 'compare' operator ('=', '!=', '>', '>=', '<', '<=' ) to
+ * compare against comment_count in a specific way.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $comment_status Comment status.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $comments_per_page The number of comments to return per page.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default 'comments_per_page' option.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2140,6 +2145,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $whichauthor .= " AND ({$wpdb->posts}.post_author = " . absint($q['author']) . ')';
</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">+ // Matching by comment count.
+ if ( isset( $q['comment_count'] ) ) {
+ // Numeric comment count is converted to array format.
+ if ( is_numeric( $q['comment_count'] ) ) {
+ $q['comment_count'] = array(
+ 'value' => intval( $q['comment_count'] ),
+ );
+ }
+
+ if ( isset( $q['comment_count']['value'] ) ) {
+ $q['comment_count'] = array_merge( array(
+ 'compare' => '=',
+ ), $q['comment_count'] );
+
+ // Fallback for invalid compare operators is '='.
+ $compare_operators = array( '=', '!=', '>', '>=', '<', '<=' );
+ if ( ! in_array( $q['comment_count']['compare'], $compare_operators, true ) ) {
+ $q['comment_count']['compare'] = '=';
+ }
+
+ $where .= $wpdb->prepare( " AND {$wpdb->posts}.comment_count {$q['comment_count']['compare']} %d", $q['comment_count']['value'] );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // MIME-Type stuff for attachment browsing
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $q['post_mime_type'] ) && '' != $q['post_mime_type'] ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsquerycommentCountphp"></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/query/commentCount.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/query/commentCount.php (rev 0)
+++ trunk/tests/phpunit/tests/query/commentCount.php 2017-07-01 11:24:26 UTC (rev 40978)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,354 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * @group query
+ */
+class Tests_Query_CommentCount extends WP_UnitTestCase {
+ static $post_ids = array();
+ public $q;
+ static $post_type = 'page'; // can be anything
+
+ public function setUp() {
+ parent::setUp();
+ unset( $this->q );
+ $this->q = new WP_Query();
+ }
+
+ public function tearDown() {
+ parent::tearDown();
+ unset( $this->q );
+ }
+
+ public static function wpSetUpBeforeClass( $factory ) {
+ $post_id = self::factory()->post->create( array( 'post_content' => 1 . rand_str() . ' about', 'post_type' => self::$post_type ) );
+ self::$post_ids[1][] = $post_id;
+ self::factory()->comment->create( array( 'comment_post_ID' => $post_id ) );
+
+ $post_id = self::factory()->post->create( array( 'post_content' => 1 . rand_str() . ' about', 'post_type' => self::$post_type ) );
+ self::$post_ids[4][] = $post_id;
+ for ( $i = 0; $i < 4; $i++ ) {
+ self::factory()->comment->create( array( 'comment_post_ID' => $post_id ) );
+ }
+
+ $post_id = self::factory()->post->create( array( 'post_content' => 1 . rand_str() . ' about', 'post_type' => self::$post_type ) );
+ self::$post_ids[5][] = $post_id;
+ for ( $i = 0; $i < 5; $i++ ) {
+ self::factory()->comment->create( array( 'comment_post_ID' => $post_id ) );
+ }
+
+ $post_id = self::factory()->post->create( array( 'post_content' => 1 . rand_str() . ' about', 'post_type' => self::$post_type ) );
+ self::$post_ids[5][] = $post_id;
+ for ( $i = 0; $i < 5; $i++ ) {
+ self::factory()->comment->create( array( 'comment_post_ID' => $post_id ) );
+ }
+ }
+
+ private function helper_get_found_post_ids() {
+ return wp_list_pluck( $this->q->posts, 'ID' );
+ }
+
+ public function test_operator_equals() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => array(
+ 'value' => 4,
+ 'compare' => '=',
+ ),
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = self::$post_ids[4];
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+
+ public function test_operator_greater_than() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => array(
+ 'value' => 4,
+ 'compare' => '>',
+ ),
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = self::$post_ids[5];
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+
+ public function test_operator_greater_than_no_results() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => array(
+ 'value' => 6,
+ 'compare' => '>',
+ ),
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = array();
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+ public function test_operator_less_than() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => array(
+ 'value' => 6,
+ 'compare' => '<',
+ ),
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = array();
+ foreach ( self::$post_ids[1] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+ foreach ( self::$post_ids[4] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+ foreach ( self::$post_ids[5] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+
+ public function test_operator_less_than_no_results() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => array(
+ 'value' => 1,
+ 'compare' => '<',
+ ),
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = array();
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+
+
+ public function test_operator_not_equal() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => array(
+ 'value' => 15,
+ 'compare' => '!=',
+ ),
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = array();
+ foreach ( self::$post_ids[1] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+ foreach ( self::$post_ids[4] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+ foreach ( self::$post_ids[5] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+
+ }
+ public function test_operator_equal_or_greater_than() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => array(
+ 'value' => 4,
+ 'compare' => '>=',
+ ),
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = array();
+ foreach ( self::$post_ids[4] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+ foreach ( self::$post_ids[5] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+
+ public function test_operator_equal_or_greater_than_no_results() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => array(
+ 'value' => 7,
+ 'compare' => '>=',
+ ),
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = array();
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+
+ public function test_operator_equal_or_less_than() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => array(
+ 'value' => 4,
+ 'compare' => '<=',
+ ),
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = array();
+ foreach ( self::$post_ids[1] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+ foreach ( self::$post_ids[4] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+
+ public function test_operator_equal_or_less_than_no_results() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => array(
+ 'value' => 0,
+ 'compare' => '<=',
+ ),
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = array();
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+
+ public function test_invalid_operator_should_fall_back_on_equals() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => array(
+ 'value' => 5,
+ 'compare' => '@',
+ ),
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = array();
+ foreach ( self::$post_ids[5] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+
+ public function test_wrong_count_no_results() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => array(
+ 'value' => 'abc',
+ 'compare' => '=',
+ ),
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = array();
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+
+ public function test_no_operator_no_results() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => array(
+ 'value' => 5,
+ ),
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = self::$post_ids[5];
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+
+ public function test_empty_non_numeric_string_should_be_ignored() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => '',
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = array();
+ foreach ( self::$post_ids[1] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+ foreach ( self::$post_ids[4] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+ foreach ( self::$post_ids[5] as $expected_id ) {
+ $expected[] = $expected_id;
+ }
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+
+ public function test_simple_count() {
+ $args = array(
+ 'post_type' => self::$post_type,
+ 'posts_per_page' => -1,
+ 'comment_count' => 5,
+ );
+ $this->q->query( $args );
+
+ $found_post_ids = $this->helper_get_found_post_ids();
+
+ $expected = self::$post_ids[5];
+
+ $this->assertEqualSets( $found_post_ids, $expected );
+ }
+}
+
</ins></span></pre>
</div>
</div>
</body>
</html>