Changeset 39126 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-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-revisions-controller.php (modified) (3 diffs)

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

@@ -94 +94 @@
                 'callback'            => array( $this, 'delete_item' ),
                 'permission_callback' => array( $this, 'delete_item_permissions_check' ),
+                'args'                => array(
+                    'force' => array(
+                        'type'        => 'boolean',
+                        'default'     => false,
+                        'description' => __( 'Required to be true, as resource does not support trashing.' ),
+                    ),
+                ),
             ),
             'schema' => array( $this, 'get_public_item_schema' ),
@@ -221 +228 @@
      */
     public function delete_item( $request ) {
+        $force = isset( $request['force'] ) ? (bool) $request['force'] : false;
+
+        // We don't support trashing for this resource type.
+        if ( ! $force ) {
+            return new WP_Error( 'rest_trash_not_supported', __( 'Revisions do not support trashing. Set force=true to delete.' ), array( 'status' => 501 ) );
+        }
+
+        $revision = $this->get_post( $request['id'] );
+        $previous = $this->prepare_item_for_response( $revision, $request );
+
         $result = wp_delete_post( $request['id'], true );
 
@@ -235 +252 @@
         do_action( 'rest_delete_revision', $result, $request );
 
-        if ( $result ) {
-            return true;
-        } else {
+        if ( ! $result ) {
             return new WP_Error( 'rest_cannot_delete', __( 'The post cannot be deleted.' ), array( 'status' => 500 ) );
         }
+
+        $response = new WP_REST_Response();
+        $response->set_data( array( 'deleted' => true, 'previous' => $previous->get_data() ) );
+        return $response;
     }