BP_REST_Document_Folder_Endpoint::delete_item( WP_REST_Request $request )
Delete a single Folder.
Description
Parameters
- $request
-
(Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-document/classes/class-bp-rest-document-folder-endpoint.php
public function delete_item( $request ) {
$id = $request['id'];
$folders = $this->assemble_response_data( array( 'folder_ids' => array( $id ) ) );
if ( empty( $folders['folders'] ) ) {
return new WP_Error(
'bp_rest_folder_invalid_id',
__( 'Invalid Folder ID.', 'buddyboss' ),
array(
'status' => 404,
)
);
}
$previous = '';
foreach ( $folders['folders'] as $folder ) {
$previous = $this->prepare_response_for_collection(
$this->document_endpoint->prepare_item_for_response( $folder, $request )
);
}
if ( ! bp_folder_user_can_delete( $id ) ) {
return WP_Error(
'bp_rest_authorization_required',
__( 'Sorry, you are not allowed to delete this folder.', 'buddyboss' ),
array(
'status' => rest_authorization_required_code(),
)
);
}
$status = bp_folder_delete( array( 'id' => $id ) );
// Build the response.
$response = new WP_REST_Response();
$response->set_data(
array(
'deleted' => $status,
'previous' => $previous,
)
);
/**
* Fires after a folder is deleted via the REST API.
*
* @param WP_REST_Response $response The response data.
* @param WP_REST_Request $request The request sent to the API.
*
* @since 0.1.0
*/
do_action( 'bp_rest_document_folder_delete_item', $response, $request );
return $response;
}
Changelog
| Version | Description |
|---|---|
| 0.1.0 | Introduced. |
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.