groups_remove_member( int $user_id, int $group_id )

Remove a member from a group.

Description

Parameters

$user_id: (Required) ID of the user.
$group_id: (Required) ID of the group.

Return

(bool) True on success, false on failure.

Source

function groups_remove_member( $user_id, $group_id ) {
 
    if ( ! bp_is_item_admin() ) {
        return false;
    }
 
    $member = new BP_Groups_Member( $user_id, $group_id );
 
    /**
     * Fires before the removal of a member from a group.
     *
     * @since BuddyPress 1.2.6
     *
     * @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', $group_id, $user_id );
 
    return $member->remove();
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.2.6	Introduced.

Uses

Uses
Uses	Description
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.
bp-core/bp-core-template.php: bp_is_item_admin()	Is the logged-in user an admin for the current item?

Used By
Used By	Description
bp-groups/bp-groups-admin.php: bp_groups_admin_load()	Set up the Groups admin page.
bp-groups/screens/single/admin/manage-members.php: groups_screen_group_admin_manage_members()	This function handles actions related to member management on the group admin.

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