REST API JavaScript Client: improve support for model deletion/trash.

Update the way and location the JavaScript client determines which models/endpoints require the `force=true` parameter when being deleted to avoid a `rest_trash_not_supported` error. Identify models with endpoints that support DELETE, excluding those that support the trash (posts and pages by default). Also, move the check into the default `wp.api.WPApiBaseModel.initialize()` function.

Props caercam, euthelup.
Fixes #40672.



git-svn-id: https://develop.svn.wordpress.org/trunk@41657 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Adam Silverstein
2017-10-01 13:06:43 +00:00
parent a0692f9597
commit 625773bd8b
2 changed files with 74 additions and 18 deletions
+36 -18
View File
@@ -770,6 +770,36 @@
wp.api.WPApiBaseModel = Backbone.Model.extend(
/** @lends WPApiBaseModel.prototype */
{
initialize: function( attributes, options ) {
/**
* Determine if a model requires ?force=true to actually delete them.
*/
if (
! _.isEmpty(
_.filter(
this.endpoints,
function( endpoint ) {
return (
// Does the method support DELETE?
'DELETE' === endpoint.methods[0] &&
// Exclude models that support trash (Post, Page).
(
! _.isUndefined( endpoint.args.force ) &&
! _.isUndefined( endpoint.args.force.description ) &&
'Whether to bypass trash and force deletion.' !== endpoint.args.force.description
)
);
}
)
)
) {
this.requireForceForDelete = true;
}
},
/**
* Set nonce header before every Backbone sync.
*
@@ -1266,23 +1296,8 @@
// Include the array of route methods for easy reference.
methods: modelRoute.route.methods,
initialize: function( attributes, options ) {
wp.api.WPApiBaseModel.prototype.initialize.call( this, attributes, options );
/**
* Posts and pages support trashing, other types don't support a trash
* and require that you pass ?force=true to actually delete them.
*
* @todo we should be getting trashability from the Schema, not hard coding types here.
*/
if (
'Posts' !== this.name &&
'Pages' !== this.name &&
_.includes( this.methods, 'DELETE' )
) {
this.requireForceForDelete = true;
}
}
// Include the array of route endpoints for easy reference.
endpoints: modelRoute.route.endpoints
} );
} else {
@@ -1317,7 +1332,10 @@
name: modelClassName,
// Include the array of route methods for easy reference.
methods: modelRoute.route.methods
methods: modelRoute.route.methods,
// Include the array of route endpoints for easy reference.
endpoints: modelRoute.route.endpoints
} );
}