Changeset 48235 for trunk/src/wp-includes/comment.php

Timestamp:

06/30/2020 02:11:00 PM (5 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.

File:

• trunk/src/wp-includes/comment.php (modified) (3 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;
         }
     }