Changeset 36381

Timestamp:

01/22/2016 08:19:49 PM (9 years ago)

Author:

boonebgorges

Message:

Allow comment query results to be limited to comments with comment_post_ID = 0.

Previously, this was not possible due to an overly broad empty() check.

Passing null, false, or '' to 'post_id', or omitting 'post_id'
altogether, will continue to return comments regardless of comment_post_ID,
as before. Passing 0 or '0' will limit results to comments with no
associated post.

Props danielbachhuber.
Fixes #35090.

Location:

trunk

Files:

• src/wp-includes/class-wp-comment-query.php (modified) (3 diffs)
• tests/phpunit/tests/comment/query.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-comment-query.php

@@ -215 +215 @@
      *     @type int          $post_ID                   Currently unused.
      *     @type int          $post_id                   Limit results to those affiliated with a given post ID.
-     *                                                   Default 0.
+     *                                                   Default null.
      *     @type array        $post__in                  Array of post IDs to include affiliated comments for.
      *                                                   Default empty.
@@ -277 +277 @@
             'post_author__not_in' => '',
             'post_ID' => '',
-            'post_id' => 0,
+            'post_id' => null,
             'post__in' => '',
             'post__not_in' => '',
@@ -646 +646 @@
         }
 
-        $post_id = absint( $this->query_vars['post_id'] );
-        if ( ! empty( $post_id ) ) {
-            $this->sql_clauses['where']['post_id'] = $wpdb->prepare( 'comment_post_ID = %d', $post_id );
+        if ( strlen( $this->query_vars['post_id'] ) ) {
+            $this->sql_clauses['where']['post_id'] = $wpdb->prepare( 'comment_post_ID = %d', $this->query_vars['post_id'] );
         }
 

trunk/tests/phpunit/tests/comment/query.php

@@ -37 +37 @@
     }
 
-    public function test_query_post_id_0() {
-        $c1 = self::factory()->comment->create( array( 'comment_post_ID' => self::$post_id, 'comment_approved' => '1' ) );
+    /**
+     * @ticket 35090
+     */
+    public function test_post_id_0_should_return_comments_with_no_parent() {
+        $c1 = self::factory()->comment->create( array( 'comment_post_ID' => self::$post_id, 'comment_approved' => '1' ) );
+        $c2 = self::factory()->comment->create( array( 'comment_post_ID' => 0, 'comment_approved' => '1' ) );
 
         $q = new WP_Comment_Query();
@@ -46 +50 @@
         ) );
 
-        $this->assertEqualSets( array( $c1 ), $found );
+        $this->assertEqualSets( array( $c2 ), $found );
+    }
+
+    /**
+     * @ticket 35090
+     */
+    public function test_post_id_string_0_should_return_comments_with_no_parent() {
+        $c1 = self::factory()->comment->create( array( 'comment_post_ID' => self::$post_id, 'comment_approved' => '1' ) );
+        $c2 = self::factory()->comment->create( array( 'comment_post_ID' => 0, 'comment_approved' => '1' ) );
+
+        $q = new WP_Comment_Query();
+        $found = $q->query( array(
+            'post_id' => '0',
+            'fields' => 'ids',
+        ) );
+
+        $this->assertEqualSets( array( $c2 ), $found );
+    }
+
+    /**
+     * @ticket 35090
+     */
+    public function test_post_id_null_should_be_ignored() {
+        $c1 = self::factory()->comment->create( array( 'comment_post_ID' => self::$post_id, 'comment_approved' => '1' ) );
+        $c2 = self::factory()->comment->create( array( 'comment_post_ID' => 0, 'comment_approved' => '1' ) );
+
+        $q = new WP_Comment_Query();
+        $found = $q->query( array(
+            'post_id' => null,
+            'fields' => 'ids',
+        ) );
+
+        $this->assertEqualSets( array( $c1, $c2 ), $found );
+    }
+
+    /**
+     * @ticket 35090
+     */
+    public function test_post_id_false_should_be_ignored() {
+        $c1 = self::factory()->comment->create( array( 'comment_post_ID' => self::$post_id, 'comment_approved' => '1' ) );
+        $c2 = self::factory()->comment->create( array( 'comment_post_ID' => 0, 'comment_approved' => '1' ) );
+
+        $q = new WP_Comment_Query();
+        $found = $q->query( array(
+            'post_id' => false,
+            'fields' => 'ids',
+        ) );
+
+        $this->assertEqualSets( array( $c1, $c2 ), $found );
+    }
+
+    /**
+     * @ticket 35090
+     */
+    public function test_post_id_empty_string_should_be_ignored() {
+        $c1 = self::factory()->comment->create( array( 'comment_post_ID' => self::$post_id, 'comment_approved' => '1' ) );
+        $c2 = self::factory()->comment->create( array( 'comment_post_ID' => 0, 'comment_approved' => '1' ) );
+
+        $q = new WP_Comment_Query();
+        $found = $q->query( array(
+            'post_id' => '',
+            'fields' => 'ids',
+        ) );
+
+        $this->assertEqualSets( array( $c1, $c2 ), $found );
     }