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

Timestamp:

11/03/2016 08:04:59 PM (8 years ago)

Author:

rachelbaker

Message:

REST API: Modify the structure of our DELETE responses to be more explicit.

Add the deleted property to the root of the Response object to communicate if the delete action was successful. Move the state of the resource prior to the delete request under a new previous property. As a result DELETE responses are now structured like so:

{ deleted: true, previous: { ... } }

Also includes helpful information to DELETE requests for resources that are not trashable.

Props timmydcrawford, rmccue, jnylen0.
Fixes #38494.

File:

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

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

@@ -84 +84 @@
                 'args'     => array(
                     'force'    => array(
+                        'type'        => 'boolean',
                         'default'     => false,
                         'description' => __( 'Whether to bypass trash and force deletion.' ),
@@ -739 +740 @@
         $request->set_param( 'context', 'edit' );
 
-        $response = $this->prepare_item_for_response( $comment, $request );
-
         if ( $force ) {
+            $previous = $this->prepare_item_for_response( $comment, $request );
             $result = wp_delete_comment( $comment->comment_ID, true );
+            $response = new WP_REST_Response();
+            $response->set_data( array( 'deleted' => true, 'previous' => $previous->get_data() ) );
         } else {
             // If this type doesn't support trashing, error out.
             if ( ! $supports_trash ) {
-                return new WP_Error( 'rest_trash_not_supported', __( 'The comment does not support trashing.' ), array( 'status' => 501 ) );
+                return new WP_Error( 'rest_trash_not_supported', __( 'The comment does not support trashing. Set force=true to delete.' ), array( 'status' => 501 ) );
             }
 
@@ -754 +756 @@
 
             $result = wp_trash_comment( $comment->comment_ID );
+            $comment = get_comment( $comment->comment_ID );
+            $response = $this->prepare_item_for_response( $comment, $request );
         }