groups_leave_group( int $group_id, int $user_id )

Remove a user from a group.

Description

Parameters

$group_id: (Required) ID of the group.
$user_id: (Optional) ID of the user. Defaults to the currently logged-in user.

Return

(bool) True on success, false on failure.

Source

function groups_leave_group( $group_id, $user_id = 0 ) {
 
    if ( empty( $user_id ) )
        $user_id = bp_loggedin_user_id();
 
    // Don't let single admins leave the group.
    if ( count( groups_get_group_admins( $group_id ) ) < 2 ) {
        if ( groups_is_user_admin( $user_id, $group_id ) ) {
            bp_core_add_message( __( 'This group must have at least one organizer.', 'buddyboss' ), 'error' );
            return false;
        }
    }
 
    if ( ! BP_Groups_Member::delete( $user_id, $group_id ) ) {
        return false;
    }
 
    bp_core_add_message( __( 'You successfully left the group.', 'buddyboss' ) );
 
    /**
     * Fires after a user leaves a group.
     *
     * @since BuddyPress 1.0.0
     *
     * @param int $group_id ID of the group.
     * @param int $user_id  ID of the user leaving the group.
     */
    do_action( 'groups_leave_group', $group_id, $user_id );
 
    return true;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.0.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/classes/class-bp-groups-member.php: BP_Groups_Member::delete()	Delete a membership, based on user + group IDs.
bp-groups/bp-groups-functions.php: groups_is_user_admin()	Check whether a user is an admin of a given group.
bp-groups/bp-groups-functions.php: groups_get_group_admins()	Get a list of group administrators.
bp-groups/bp-groups-functions.php: groups_leave_group	Fires after a user leaves a group.
bp-core/bp-core-template.php: bp_loggedin_user_id()	Get the ID of the currently logged-in user.
bp-core/bp-core-functions.php: bp_core_add_message()	Add a feedback (error/success) message to the WP cookie so it can be displayed after the page reloads.

Show 1 more use Hide more uses

Used By
Used By	Description
bp-groups/actions/leave-group.php: groups_action_leave_group()	Catch and process “Leave Group” button clicks.
bp-templates/bp-nouveau/includes/groups/ajax.php: bp_nouveau_ajax_joinleave_group()	Join or leave a group when clicking the “join/leave” button via a POST request.

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