Changeset 39628

Timestamp:

12/21/2016 05:12:06 AM (8 years ago)

Author:

pento

Message:

REST API: Allow sending an empty or no-op comment update.

In general, updates that don't actually change anything should succeed. [39371] added tests for other object types, and this commit fixes empty updates for comments and adds the missing test.

Merges [39597] to the 4.7 branch.

Props jnylen0.
Fixes #38700.

Location:

branches/4.7

Files:

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

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

@@ -665 +665 @@
         }
 
+        if ( ! empty( $prepared_args['comment_post_ID'] ) ) {
+            $post = get_post( $prepared_args['comment_post_ID'] );
+            if ( empty( $post ) ) {
+                return new WP_Error( 'rest_comment_invalid_post_id', __( 'Invalid post ID.' ), array( 'status' => 403 ) );
+            }
+        }
+
         if ( empty( $prepared_args ) && isset( $request['status'] ) ) {
             // Only the comment status is being changed.
@@ -691 +698 @@
             $updated = wp_update_comment( wp_slash( (array) $prepared_args ) );
 
-            if ( 0 === $updated ) {
+            if ( false === $updated ) {
                 return new WP_Error( 'rest_comment_failed_edit', __( 'Updating comment failed.' ), array( 'status' => 500 ) );
             }

branches/4.7/tests/phpunit/tests/rest-api/rest-comments-controller.php

@@ -1962 +1962 @@
     }
 
+    public function test_update_item_no_change() {
+        $comment = get_comment( self::$approved_id );
+
+        wp_set_current_user( self::$admin_id );
+        $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/comments/%d', self::$approved_id ) );
+        $request->set_param( 'post', $comment->comment_post_ID );
+
+        // Run twice to make sure that the update still succeeds even if no DB
+        // rows are updated.
+        $response = $this->server->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+
+        $response = $this->server->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+    }
+
     public function test_update_comment_status() {
         wp_set_current_user( self::$admin_id );
@@ -2205 +2221 @@
         $response = $this->server->dispatch( $request );
         $this->assertErrorResponse( 'rest_comment_invalid_id', $response, 404 );
+    }
+
+    public function test_update_comment_invalid_post_id() {
+        wp_set_current_user( self::$admin_id );
+
+        $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/comments/%d', self::$approved_id ) );
+        $request->set_param( 'post', REST_TESTS_IMPOSSIBLY_HIGH_NUMBER );
+
+        $response = $this->server->dispatch( $request );
+        $this->assertErrorResponse( 'rest_comment_invalid_post_id', $response, 403 );
     }