BP_REST_Attachments_Group_Cover_Endpoint::delete_item( WP_REST_Request $request )
Delete an existing group cover.
Description
Parameters
- $request
-
(Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-groups/classes/class-bp-rest-attachments-group-cover-endpoint.php
public function delete_item( $request ) {
$request->set_param( 'context', 'edit' );
$cover_url = bp_get_group_cover_url( $this->group );
$deleted = bp_attachments_delete_file(
array(
'item_id' => (int) $this->group->id,
'object_dir' => $this->get_cover_object_component(),
'type' => 'cover-image',
)
);
if ( ! $deleted ) {
return new WP_Error(
'bp_rest_attachments_group_cover_delete_failed',
__( 'Sorry, there was a problem deleting this group cover.', 'buddyboss' ),
array(
'status' => 500,
)
);
}
// Build the response.
$response = new WP_REST_Response();
$response->set_data(
array(
'deleted' => true,
'previous' => $cover_url,
)
);
/**
* Fires after a group cover is deleted via the REST API.
*
* @param BP_Groups_Group $group The group object.
* @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_attachments_group_cover_delete_item', $this->group, $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.