BP_REST_Members_Endpoint::delete_item( WP_REST_Request $request )
Deletes a single user.
Description
Parameters
- $request
-
(WP_REST_Request) (Required) Full details about the request.
Return
(WP_REST_Response|WP_Error) Response object on success, or WP_Error object on failure.
Source
File: bp-members/classes/class-bp-rest-members-endpoint.php
public function delete_item( $request ) { $user_id = (int) $request['id']; if ( empty( $user_id ) ) { $user_id = bp_loggedin_user_id(); } if ( empty( $user_id ) ) { return new WP_Error( 'bp_rest_member_invalid_id', __( 'Invalid member ID.', 'buddyboss' ), array( 'status' => 404, ) ); } $user = bp_rest_get_user( $user_id ); if ( ! $user instanceof WP_User ) { return new WP_Error( 'bp_rest_member_invalid_id', __( 'Invalid member ID.', 'buddyboss' ), array( 'status' => 404, ) ); } $previous = $this->prepare_item_for_response( $user, $request ); $status = false; if ( bp_core_delete_account( $user_id ) ) { $status = true; } $response = new WP_REST_Response(); $response->set_data( array( 'deleted' => $status, 'previous' => $previous->get_data(), ) ); /** * Fires immediately after a user is deleted via the REST API. * * @since 4.7.0 * * @param WP_User $user The user data. * @param WP_REST_Response $response The response returned from the API. * @param WP_REST_Request $request The request sent to the API. */ do_action( 'bp_rest_delete_user', $user, $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.