BP_REST_Group_Membership_Endpoint::delete_item( WP_REST_Request $request )

Delete a group membership.

Description

Parameters

$request: (Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

File: bp-groups/classes/class-bp-rest-group-membership-endpoint.php

public function delete_item( $request ) {
    // Setting context.
    $request->set_param( 'context', 'edit' );
 
    // Get the Group member before it's removed.
    $member   = new BP_Groups_Member( $request['user_id'], $request['group_id'] );
    $previous = $this->prepare_item_for_response( $member, $request );
 
    /**
     * Fires before the removal of a member from a group.
     *
     * @param int $group_id ID of the group being removed from.
     * @param int $user_id  ID of the user being removed.
     */
    do_action( 'groups_remove_member', $request['group_id'], $request['user_id'] );
 
    if ( ! $member->remove() ) {
        return new WP_Error(
            'bp_rest_group_member_failed_to_remove',
            __( 'Could not remove member from this group.', 'buddyboss' ),
            array(
                'status' => 500,
            )
        );
    }
 
    /**
     * Fires after a group member has been removed.
     *
     * @param int $user_id  ID of the user being updated.
     * @param int $group_id ID of the group.
     */
    do_action( 'groups_removed_member', $request['user_id'], $request['group_id'] );
 
    // Build the response.
    $response = new WP_REST_Response();
    $response->set_data(
        array(
            'removed'  => true,
            'previous' => $previous->get_data(),
        )
    );
 
    $user  = bp_rest_get_user( $request['user_id'] );
    $group = $this->groups_endpoint->get_group_object( $request['group_id'] );
 
    /**
     * Fires after a group member is deleted via the REST API.
     *
     * @param WP_User $user The updated member.
     * @param BP_Groups_Member $member The group member object.
     * @param BP_Groups_Group $group The group 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_group_members_delete_item', $user, $member, $group, $response, $request );
 
    return $response;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
0.1.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: BP_REST_Group_Membership_Endpoint::prepare_item_for_response()	Prepares group member data for return as an object.
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: bp_rest_group_members_delete_item	Fires after a group member is deleted via the REST API.
bp-core/bp-core-rest-api.php: bp_rest_get_user()	Get the user object, if the ID is valid.
bp-groups/screens/single/admin/manage-members.php: groups_removed_member	Fires before the redirect after a group member has been removed.
bp-groups/classes/class-bp-groups-member.php: BP_Groups_Member::__construct()	Constructor method.
bp-groups/bp-groups-functions.php: groups_remove_member	Fires before the removal of a member from a group.

Show 1 more use Hide more uses

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.

Contents