Changeset 39922

Timestamp:

01/17/2017 05:17:15 AM (8 years ago)

Author:

rmccue

Message:

REST API: Allow shortcircuiting rest_pre_insert_comment

rest_pre_insert_{post_type} allows returning a WP_Error from the filter to shortcircuit actually creating the object, so it makes sense to do so for comments too.

Props dspilka.
Fixes #39578.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-comments-controller.php (modified) (1 diff)

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

@@ -553 +553 @@
          *
          * Allows modification of the comment right before it is inserted via wp_insert_comment().
+         * Returning a WP_Error value from the filter will shortcircuit insertion and allow
+         * skipping further processing.
          *
          * @since 4.7.0
-         *
-         * @param array           $prepared_comment The prepared comment data for wp_insert_comment().
+         * @since 4.8.0 $prepared_comment can now be a WP_Error to shortcircuit insertion.
+         *
+         * @param array|WP_Error  $prepared_comment The prepared comment data for wp_insert_comment().
          * @param WP_REST_Request $request          Request used to insert the comment.
          */
         $prepared_comment = apply_filters( 'rest_pre_insert_comment', $prepared_comment, $request );
+        if ( is_wp_error( $prepared_comment ) ) {
+            return $prepared_comment;
+        }
 
         $comment_id = wp_insert_comment( wp_filter_comment( wp_slash( (array) $prepared_comment ) ) );

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

@@ -984 +984 @@
         $new_comment = get_comment( $data['id'] );
         $this->assertEquals( $params['content']['raw'], $new_comment->comment_content );
+    }
+
+    public function test_create_item_error_from_filter() {
+        add_filter( 'rest_pre_insert_comment', array( $this, 'return_premade_error' ) );
+        wp_set_current_user( self::$admin_id );
+
+        $params = array(
+            'post'         => self::$post_id,
+            'author_name'  => 'Homer Jay Simpson',
+            'author_email' => 'homer@example.org',
+            'content'      => array(
+                'raw' => 'Aw, he loves beer. Here, little fella.'
+            ),
+        );
+
+        $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
+        $request->add_header( 'content-type', 'application/json' );
+        $request->set_body( wp_json_encode( $params ) );
+
+        $response = $this->server->dispatch( $request );
+
+        $this->assertErrorResponse( 'test_rest_premade_error', $response, 418 );
+    }
+
+    public function return_premade_error() {
+        return new WP_Error( 'test_rest_premade_error', "I'm sorry, I thought he was a party robot.", array( 'status' => 418 ) );
     }