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

Timestamp:

11/03/2016 08:04:59 PM (9 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-users-controller.php (modified) (5 diffs)

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

@@ -86 +86 @@
                 'args'                => array(
                     'force'    => array(
+                        'type'        => 'boolean',
                         'default'     => false,
                         'description' => __( 'Required to be true, as resource does not support trashing.' ),
@@ -115 +116 @@
                 'args'                => array(
                     'force'    => array(
+                        'type'        => 'boolean',
                         'default'     => false,
                         'description' => __( 'Required to be true, as resource does not support trashing.' ),
@@ -654 +656 @@
         // We don't support trashing for this type, error out.
         if ( ! $force ) {
-            return new WP_Error( 'rest_trash_not_supported', __( 'Users do not support trashing.' ), array( 'status' => 501 ) );
+            return new WP_Error( 'rest_trash_not_supported', __( 'Users do not support trashing. Set force=true to delete.' ), array( 'status' => 501 ) );
         }
 
@@ -671 +673 @@
         $request->set_param( 'context', 'edit' );
 
-        $response = $this->prepare_item_for_response( $user, $request );
+        $previous = $this->prepare_item_for_response( $user, $request );
 
         /** Include admin user functions to get access to wp_delete_user() */
@@ -681 +683 @@
             return new WP_Error( 'rest_cannot_delete', __( 'The resource cannot be deleted.' ), array( 'status' => 500 ) );
         }
+
+        $response = new WP_REST_Response();
+        $response->set_data( array( 'deleted' => true, 'previous' => $previous->get_data() ) );
 
         /**