BP_REST_Friends_Endpoint::delete_item( WP_REST_Request $request )
Reject/withdraw/remove friendship.
Parameters Parameters
- $request
-
(WP_REST_Request) (Required) Full details about the request.
Return Return
(WP_REST_Response|WP_Error)
Source Source
File: bp-friends/classes/class-bp-rest-friends-endpoint.php
public function delete_item( $request ) { $user = get_user_by( 'id', $request->get_param( 'id' ) ); // Check if user is valid. if ( false === $user ) { return new WP_Error( 'bp_rest_friends_delete_item_failed', __( 'There was a problem confirming if user is valid.', 'buddypress' ), array( 'status' => 404, ) ); } // Get friendship. $friendship = $this->get_friendship_object( BP_Friends_Friendship::get_friendship_id( bp_loggedin_user_id(), $user->ID ) ); if ( ! $friendship || empty( $friendship->id ) ) { return new WP_Error( 'bp_rest_invalid_id', __( 'Invalid friendship ID.', 'buddypress' ), array( 'status' => 404, ) ); } $previous = $this->prepare_item_for_response( $friendship, $request ); // Remove a friendship. if ( true === $request->get_param( 'force' ) ) { $deleted = friends_remove_friend( $friendship->initiator_user_id, $friendship->friend_user_id ); } else { /** * If this change is being initiated by the initiator, * use the `reject` function. * * This is the user who requested the friendship, and is doing the withdrawing. */ if ( bp_loggedin_user_id() === $friendship->initiator_user_id ) { $deleted = friends_withdraw_friendship( $friendship->initiator_user_id, $friendship->friend_user_id ); } else { /** * Otherwise, this change is being initiated by the user, friend, * who received the friendship reject. */ $deleted = friends_reject_friendship( $friendship->id ); } } if ( false === $deleted ) { return new WP_Error( 'bp_rest_friends_cannot_delete_item', __( 'Could not delete friendship.', 'buddypress' ), array( 'status' => 500, ) ); } // Build the response. $response = new WP_REST_Response(); $response->set_data( array( 'deleted' => true, 'previous' => $previous->get_data(), ) ); /** * Fires after a friendship is deleted via the REST API. * * @since 6.0.0 * * @param BP_Friends_Friendship $friendship Friendship object. * @param WP_REST_Response $response The response data. * @param WP_REST_Request $request The request sent to the API. */ do_action( 'bp_rest_friends_delete_item', $friendship, $response, $request ); return $response; }
Expand full source code Collapse full source code View on Trac
Changelog Changelog
Version | Description |
---|---|
6.0.0 | Introduced. |