BP_REST_XProfile_Data_Endpoint::delete_item( WP_REST_Request $request )
Delete user’s xProfile data.
Description
Parameters
- $request
-
(Required) Full data about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-xprofile/classes/class-bp-rest-xprofile-data-endpoint.php
public function delete_item( $request ) { // Setting context. $request->set_param( 'context', 'edit' ); $field = $this->get_xprofile_field_object( $request->get_param( 'field_id' ) ); if ( empty( $field->id ) ) { return new WP_Error( 'bp_rest_invalid_id', __( 'Invalid field ID.', 'buddyboss' ), array( 'status' => 404, ) ); } $user = bp_rest_get_user( $request->get_param( 'user_id' ) ); // Get the field data before it's deleted. $field_data = $this->get_xprofile_field_data_object( $field->id, $user->ID ); // Set empty for the response. $field_data->value = ''; $previous = $this->prepare_item_for_response( $field_data, $request ); if ( false === $field_data->delete() ) { return new WP_Error( 'bp_rest_xprofile_data_cannot_delete', __( 'Could not delete XProfile data.', 'buddyboss' ), array( 'status' => 500, ) ); } // Build the response. $response = new WP_REST_Response(); $response->set_data( array( 'deleted' => true, 'previous' => $previous->get_data(), ) ); /** * Fires after a XProfile data is deleted via the REST API. * * @param BP_XProfile_Field $field Deleted field object. * @param BP_XProfile_ProfileData $field_data Deleted field data object. * @param WP_User $user User 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_xprofile_data_delete_item', $field, $field_data, $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.