Changeset 48230

Timestamp:

06/30/2020 12:01:05 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Comments: Add a @since note to the wp_update_comment_data filter about returning a WP_Error value.

Remove the ability to short-circuit comment update by returning false from the filter for now.

This was inconsistent with the pre_comment_approved filter, and should not be necessary if a more descriptive reason can be given by always using WP_Error.

See #39732.

File:

• trunk/src/wp-includes/comment.php (modified) (1 diff)

trunk/src/wp-includes/comment.php

@@ -2491 +2491 @@
      * Filters the comment data immediately before it is updated in the database.
      *
-     * Note: data being passed to the filter is already unslashed. Returning false
-     * or a WP_Error object would prevent the comment from being updated.
+     * Note: data being passed to the filter is already unslashed.
      *
      * @since 4.7.0
-     * @since 5.5.0 The `$wp_error` parameter was added.
-     *
-     * @param array $data       The new, processed comment data.
-     * @param array $comment    The old, unslashed comment data.
-     * @param array $commentarr The new, raw comment data.
-     * @param bool  $wp_error   Whether to return a WP_Error on failure.
-     */
-    $data = apply_filters( 'wp_update_comment_data', $data, $comment, $commentarr, $wp_error );
-
-    if ( ! $data ) {
-        $data = new WP_Error( 'comment_update_canceled', __( 'Comment update canceled.' ) );
-    }
+     * @since 5.5.0 Returning a WP_Error value from the filter will short-circuit comment update
+     *              and allow skipping further processing.
+     *
+     * @param array|WP_Error $data       The new, processed comment data, or WP_Error.
+     * @param array          $comment    The old, unslashed comment data.
+     * @param array          $commentarr The new, raw comment data.
+     */
+    $data = apply_filters( 'wp_update_comment_data', $data, $comment, $commentarr );
 
     // Do not carry on on failure.