Changeset 39196

Timestamp:

11/10/2016 03:34:30 AM (9 years ago)

Author:

joehoyle

Message:

REST API: Allow updating a comment without the content present.

For all resources in the REST API, sending partial updates is supported. This fixes needing to _always_ specify comment content.

Props jnylen.
Fixes #38720.

Location:

trunk

Files:

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

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

@@ -432 +432 @@
 
         /*
-         * Do not allow a comment to be created with an empty string for
+         * Do not allow a comment to be created with missing or empty
          * comment_content. See wp_handle_comment_submission().
          */
-        if ( '' === $prepared_comment['comment_content'] ) {
+        if ( empty( $prepared_comment['comment_content'] ) ) {
             return new WP_Error( 'rest_comment_content_invalid', __( 'Comment content is invalid.' ), array( 'status' => 400 ) );
         }
@@ -635 +635 @@
             if ( is_wp_error( $prepared_args ) ) {
                 return $prepared_args;
+            }
+
+            if ( isset( $prepared_args['comment_content'] ) && empty( $prepared_args['comment_content'] ) ) {
+                return new WP_Error( 'rest_comment_content_invalid', __( 'Comment content is invalid.' ), array( 'status' => 400 ) );
             }
 
@@ -1063 +1067 @@
                 list( $prepared_comment['comment_date'], $prepared_comment['comment_date_gmt'] ) = $date_data;
             }
-        }
-
-        // Require 'comment_content' unless only the 'comment_status' is being updated.
-        if ( ! empty( $prepared_comment ) && ! isset( $prepared_comment['comment_content'] ) ) {
-            return new WP_Error( 'rest_comment_content_required', __( 'Missing comment content.' ), array( 'status' => 400 ) );
         }
 

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

@@ -930 +930 @@
     }
 
-    public function test_create_item_invalid_blank_content() {
+    public function test_create_item_invalid_no_content() {
         wp_set_current_user( 0 );
 
@@ -938 +938 @@
             'author_email' => 'lovejoy@example.com',
             'author_url'   => 'http://timothylovejoy.jr',
-            'content'      => '',
-        );
-
-        $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
-        $request->add_header( 'content-type', 'application/json' );
-        $request->set_body( wp_json_encode( $params ) );
-
+        );
+
+        $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( 'rest_comment_content_invalid', $response, 400 );
+
+        $params['content'] = '';
+        $request->set_body( wp_json_encode( $params ) );
         $response = $this->server->dispatch( $request );
         $this->assertErrorResponse( 'rest_comment_content_invalid', $response, 400 );
@@ -1617 +1621 @@
         $this->assertEquals( mysql_to_rfc3339( $updated->comment_date ), $comment['date'] );
         $this->assertEquals( '2014-11-07T10:14:25', $comment['date'] );
+    }
+
+    public function test_update_item_no_content() {
+        $post_id = $this->factory->post->create();
+
+        wp_set_current_user( self::$admin_id );
+
+        $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/comments/%d', self::$approved_id ) );
+        $request->set_param( 'author_email', 'another@email.com' );
+
+        // Sending a request without content is fine.
+        $response = $this->server->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+
+        // Sending a request with empty comment is not fine.
+        $request->set_param( 'author_email', 'yetanother@email.com' );
+        $request->set_param( 'content', '' );
+        $response = $this->server->dispatch( $request );
+        $this->assertErrorResponse( 'rest_comment_content_invalid', $response, 400 );
     }