BP_REST_Notifications_Endpoint::delete_item( WP_REST_Request $request )
Delete a notification.
Description
Parameters
- $request
-
(Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-notifications/classes/class-bp-rest-notifications-endpoint.php
public function delete_item( $request ) {
// Setting context.
$request->set_param( 'context', 'edit' );
// Get the notification before it's deleted.
$notification = $this->get_notification_object( $request );
$previous = $this->prepare_item_for_response( $notification, $request );
if ( ! BP_Notifications_Notification::delete( array( 'id' => $notification->id ) ) ) {
return new WP_Error(
'bp_rest_notification_invalid_id',
__( 'Invalid notification ID.', 'buddyboss' ),
array(
'status' => 404,
)
);
}
// Build the response.
$response = new WP_REST_Response();
$response->set_data(
array(
'deleted' => true,
'previous' => $previous->get_data(),
)
);
/**
* Fires after a notification is deleted via the REST API.
*
* @param BP_Notifications_Notification $notification The deleted notification.
* @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_notifications_delete_item', $notification, $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.