Changeset 48154

Timestamp:

06/24/2020 12:03:33 AM (4 years ago)

Author:

whyisjake

Message:

Comments: Allow wp_update_comment() to return WP_Error().

The wp_update_comment_data filter introduced in 4.7 allows comment data to be filtered before it is updated in the database.

The patch aims to handle WP_Error as the filter above return value in a similar manner as is done for wp_new_comment().

Fixes #39732.

Props: enricosorcinelli, swissspidy, gkloveweb, jnylen0, jbpaul17, afercia, SergeyBiryukov, audrasjb, imath, davidbaumwald.

Location:

trunk

Files:

• src/wp-admin/comment.php (modified) (1 diff)
• src/wp-admin/includes/ajax-actions.php (modified) (1 diff)
• src/wp-admin/includes/comment.php (modified) (1 diff)
• src/wp-includes/class-wp-xmlrpc-server.php (modified) (1 diff)
• src/wp-includes/comment.php (modified) (3 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (1 diff)
• tests/phpunit/tests/ajax/EditComment.php (modified) (2 diffs)
• tests/phpunit/tests/comment.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-comments-controller.php (modified) (1 diff)

trunk/src/wp-admin/comment.php

@@ -340 +340 @@
         check_admin_referer( 'update-comment_' . $comment_id );
 
-        edit_comment();
+        $updated = edit_comment();
+        if ( is_wp_error( $updated ) ) {
+            wp_die( $updated->get_error_message() );
+        }
 
         $location = ( empty( $_POST['referredby'] ) ? "edit-comments.php?p=$comment_post_id" : $_POST['referredby'] ) . '#comment-' . $comment_id;

trunk/src/wp-admin/includes/ajax-actions.php

@@ -1411 +1411 @@
         $_POST['comment_status'] = $_POST['status'];
     }
-    edit_comment();
+
+    $updated = edit_comment();
+    if ( is_wp_error( $updated ) ) {
+        wp_die( $updated->get_error_message() );
+    }
 
     $position      = ( isset( $_POST['position'] ) && (int) $_POST['position'] ) ? (int) $_POST['position'] : '-1';

trunk/src/wp-admin/includes/comment.php

@@ -93 +93 @@
     }
 
-    wp_update_comment( $_POST );
+    return wp_update_comment( $_POST, true );
 }
 

trunk/src/wp-includes/class-wp-xmlrpc-server.php

@@ -3789 +3789 @@
         }
 
-        $result = wp_update_comment( $comment );
-        if ( is_wp_error( $result ) ) {
+        $result = wp_update_comment( $comment, true );
+        if ( is_wp_error( $result ) || false === $result ) {
             return new IXR_Error( 500, $result->get_error_message() );
         }

trunk/src/wp-includes/comment.php

@@ -2406 +2406 @@
  * @since 2.0.0
  * @since 4.9.0 Add updating comment meta during comment update.
+ * @since 5.5.0 Allow returning a WP_Error object on failure.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param array $commentarr Contains information on the comment.
- * @return int The value 1 if the comment was updated, 0 if not updated.
- */
-function wp_update_comment( $commentarr ) {
+ * @param bool  $wp_error   Optional. Whether to return a WP_Error on failure. Default false.
+ * @return int|bool|WP_Error Comment was updated if value is 1, or was not updated if value is 0,
+ *                           false, or a WP_Error object.
+ */
+function wp_update_comment( $commentarr, $wp_error = false ) {
     global $wpdb;
 
@@ -2418 +2421 @@
     $comment = get_comment( $commentarr['comment_ID'], ARRAY_A );
     if ( empty( $comment ) ) {
-        return 0;
+        if ( ! $wp_error ) {
+            return 0;
+        }
+
+        return new WP_Error( 'invalid_comment_id', __( 'Invalid comment ID.' ) );
     }
 
     // Make sure that the comment post ID is valid (if specified).
     if ( ! empty( $commentarr['comment_post_ID'] ) && ! get_post( $commentarr['comment_post_ID'] ) ) {
-        return 0;
+        if ( ! $wp_error ) {
+            return 0;
+        }
+
+        return new WP_Error( 'invalid_post_id', __( 'Invalid post ID.' ) );
     }
 
@@ -2464 +2475 @@
      * Filters the comment data immediately before it is updated in the database.
      *
-     * Note: data being passed to the filter is already unslashed.
+     * Note: data being passed to the filter is already unslashed. Returning 0 or a
+     * WP_Error object is preventing the comment to be updated.
      *
      * @since 4.7.0
+     * @since 5.5.0 Allow returning a WP_Error object on failure.
      *
      * @param array $data       The new, processed comment data.
      * @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 );
+     * @param bool  $wp_error   Optional. Whether to return a WP_Error on failure.
+     *                          Default false.
+     */
+    $data = apply_filters( 'wp_update_comment_data', $data, $comment, $commentarr, $wp_error );
+
+    // Do not carry on on failure.
+    if ( is_wp_error( $data ) || 0 === $data ) {
+        return $data;
+    }
 
     $keys = array( 'comment_post_ID', 'comment_content', 'comment_author', 'comment_author_email', 'comment_approved', 'comment_karma', 'comment_author_url', 'comment_date', 'comment_date_gmt', 'comment_type', 'comment_parent', 'user_id', 'comment_agent', 'comment_author_IP' );

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

@@ -869 +869 @@
             }
 
-            $updated = wp_update_comment( wp_slash( (array) $prepared_args ) );
-
-            if ( false === $updated ) {
+            $updated = wp_update_comment( wp_slash( (array) $prepared_args ), true );
+
+            if ( is_wp_error( $updated ) || false === $updated ) {
                 return new WP_Error(
                     'rest_comment_failed_edit',

trunk/tests/phpunit/tests/ajax/EditComment.php

@@ -33 +33 @@
     }
 
+    public function tearDown() {
+        remove_filter( 'wp_update_comment_data', array( $this, '_wp_update_comment_data_filter' ), 10, 3 );
+        parent::tearDown();
+    }
+
     /**
      * Get comments as a privilged user (administrator)
@@ -128 +133 @@
 
     /**
+     * @ticket 39732
+     */
+    public function test_wp_update_comment_data_is_wp_error() {
+        // Become an administrator
+        $this->_setRole( 'administrator' );
+
+        // Get a comment
+        $comments = get_comments(
+            array(
+                'post_id' => $this->_comment_post->ID,
+            )
+        );
+        $comment  = array_pop( $comments );
+
+        // Set up a default request
+        $_POST['_ajax_nonce-replyto-comment'] = wp_create_nonce( 'replyto-comment' );
+        $_POST['comment_ID']                  = $comment->comment_ID;
+        $_POST['content']                     = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.';
+
+        // Simulate filter check error
+        add_filter( 'wp_update_comment_data', array( $this, '_wp_update_comment_data_filter' ), 10, 3 );
+
+        // Make the request
+        $this->setExpectedException( 'WPAjaxDieStopException', 'wp_update_comment_data filter fails for this comment.' );
+        $this->_handleAjax( 'edit-comment' );
+    }
+
+    /**
+     * Block comments from being updated by returning WP_Error
+     */
+    public function _wp_update_comment_data_filter( $data, $comment, $commentarr ) {
+        return new WP_Error( 'comment_wrong', __( 'wp_update_comment_data filter fails for this comment.' ), 500 );
+    }
+
+    /**
      * Get comments as a non-privileged user (subscriber)
      * Expects test to fail

trunk/tests/phpunit/tests/comment.php

@@ -141 +141 @@
         $comment = get_comment( $comment_id );
         $this->assertEquals( $updated_comment_text, $comment->comment_content );
+    }
+
+    /**
+     * @ticket 39732
+     */
+    public function test_wp_update_comment_is_wp_error() {
+        $comment_id = self::factory()->comment->create( array( 'comment_post_ID' => self::$post_id ) );
+
+        add_filter( 'wp_update_comment_data', array( $this, '_wp_update_comment_data_filter' ), 10, 3 );
+        $result = wp_update_comment(
+            array(
+                'comment_ID'   => $comment_id,
+                'comment_type' => 'pingback',
+            ),
+            true
+        );
+        $this->assertWPError( $result );
+        remove_filter( 'wp_update_comment_data', array( $this, '_wp_update_comment_data_filter' ), 10, 3 );
+    }
+
+    /**
+     * Block comments from being updated by returning WP_Error
+     */
+    public function _wp_update_comment_data_filter( $data, $comment, $commentarr ) {
+        return new WP_Error( 'comment_wrong', __( 'wp_update_comment_data filter fails for this comment.' ), 500 );
     }
 

trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php

@@ -2791 +2791 @@
     }
 
+    /**
+     * @ticket 39732
+     */
+    public function test_update_comment_is_wp_error() {
+        wp_set_current_user( self::$admin_id );
+
+        $params = array(
+            'content' => 'This isn\'t a saxophone. It\'s an umbrella.',
+        );
+
+        add_filter( 'wp_update_comment_data', array( $this, '_wp_update_comment_data_filter' ), 10, 3 );
+
+        $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/comments/%d', self::$approved_id ) );
+
+        $request->add_header( 'content-type', 'application/json' );
+        $request->set_body( wp_json_encode( $params ) );
+        $response = rest_get_server()->dispatch( $request );
+
+        $this->assertErrorResponse( 'rest_comment_failed_edit', $response, 500 );
+
+        remove_filter( 'wp_update_comment_data', array( $this, '_wp_update_comment_data_filter' ), 10, 3 );
+    }
+
+    /**
+     * Block comments from being updated by returning WP_Error
+     */
+    public function _wp_update_comment_data_filter( $data, $comment, $commentarr ) {
+        return new WP_Error( 'comment_wrong', __( 'wp_update_comment_data filter fails for this comment.' ), array( 'status' => 500 ) );
+    }
+
     public function verify_comment_roundtrip( $input = array(), $expected_output = array() ) {
         // Create the comment.