BP_REST_Invites_Endpoint::delete_item( WP_REST_Request $request )
Delete a invites.
Description
Parameters
- $request
-
(Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-invites/classes/class-bp-rest-invites-endpoint.php
public function delete_item( $request ) {
// Setting context.
$request->set_param( 'context', 'edit' );
$invite = get_post( $request['id'] );
$previous = $this->prepare_response_for_collection(
$this->prepare_item_for_response( $invite, $request )
);
$success = wp_delete_post( $invite->ID );
// Build the response.
$response = new WP_REST_Response();
$response->set_data(
array(
'deleted' => ( ! empty( $success ) && ! is_wp_error( $success ) ? true : $success ),
'previous' => $previous,
)
);
/**
* Fires after a invitation is deleted via the REST API.
*
* @param object $invite The deleted invitation.
* @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_invites_delete_item', $invite, $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.