Changeset 48235

Timestamp:

06/30/2020 02:11:00 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Comments: Make wp_update_comment() return false instead of 0 for an invalid comment or post ID.

This addresses an inconsistency where 0 could mean one of the three scenarios:

• Invalid comment ID.
• Invalid comment post ID.
• No DB rows updated. This is not an error and should not be treated as one.

With this change, wp_update_comment() always returns either false or a WP_Error object on failure, depending on the value of the $wp_error parameter.

Follow-up to [48154], [48215], [48216], [48218], [48230].

Props dd32, jnylen0, enrico.sorcinelli.
Fixes #39732. See #38700, #39735.

Location:

trunk

Files:

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

trunk/src/wp-includes/comment.php

@@ -2423 +2423 @@
  * @since 4.9.0 Add updating comment meta during comment update.
  * @since 5.5.0 The `$wp_error` parameter was added.
+ * @since 5.5.0 The return values for an invalid comment or post ID
+ *              were changed to false instead of 0.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -2440 +2442 @@
             return new WP_Error( 'invalid_comment_id', __( 'Invalid comment ID.' ) );
         } else {
-            return 0;
+            return false;
         }
     }
@@ -2449 +2451 @@
             return new WP_Error( 'invalid_post_id', __( 'Invalid post ID.' ) );
         } else {
-            return 0;
+            return false;
         }
     }

trunk/tests/phpunit/tests/comment.php

@@ -32 +32 @@
 
     public function test_wp_update_comment() {
-        $post     = self::factory()->post->create_and_get(
+        $post  = self::factory()->post->create_and_get(
             array(
                 'post_title' => 'some-post',
@@ -38 +38 @@
             )
         );
-        $post2    = self::factory()->post->create_and_get(
+        $post2 = self::factory()->post->create_and_get(
             array(
                 'post_title' => 'some-post-2',
@@ -44 +44 @@
             )
         );
+
         $comments = self::factory()->comment->create_post_comments( $post->ID, 5 );
-        $result   = wp_update_comment(
+
+        $result = wp_update_comment(
             array(
                 'comment_ID'     => $comments[0],
@@ -52 +54 @@
         );
         $this->assertEquals( 1, $result );
+
         $comment = get_comment( $comments[0] );
         $this->assertEquals( $comments[1], $comment->comment_parent );
+
         $result = wp_update_comment(
             array(
@@ -61 +65 @@
         );
         $this->assertEquals( 0, $result );
-        $result  = wp_update_comment(
+
+        $result = wp_update_comment(
             array(
                 'comment_ID'      => $comments[0],
@@ -67 +72 @@
             )
         );
+
         $comment = get_comment( $comments[0] );
         $this->assertEquals( $post2->ID, $comment->comment_post_ID );
@@ -93 +99 @@
     public function test_wp_update_comment_updates_comment_meta() {
         $comment_id = self::factory()->comment->create( array( 'comment_post_ID' => self::$post_id ) );
+
         wp_update_comment(
             array(
@@ -102 +109 @@
             )
         );
+
         $this->assertEquals( 'fire', get_comment_meta( $comment_id, 'sauce', true ) );
     }
@@ -141 +149 @@
         $comment = get_comment( $comment_id );
         $this->assertEquals( $updated_comment_text, $comment->comment_content );
+    }
+
+    /**
+     * @ticket 39732
+     */
+    public function test_wp_update_comment_returns_false_for_invalid_comment_or_post_id() {
+        $comment_id = self::factory()->comment->create( array( 'comment_post_ID' => self::$post_id ) );
+
+        $update = wp_update_comment(
+            array(
+                'comment_ID'      => -1,
+                'comment_post_ID' => self::$post_id,
+            )
+        );
+        $this->assertSame( false, $update );
+
+        $update = wp_update_comment(
+            array(
+                'comment_ID'      => $comment_id,
+                'comment_post_ID' => -1,
+            )
+        );
+        $this->assertSame( false, $update );
     }