groups_is_user_banned( int $user_id, int $group_id )

Check whether a user is banned from a given group.

Description

Parameters

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

Return

(int|bool) ID of the membership if the user is banned, otherwise false.

Source

function groups_is_user_banned( $user_id, $group_id ) {
    $is_banned = false;
 
    $user_groups = bp_get_user_groups( $user_id, array(
        'is_confirmed' => null,
        'is_banned' => true,
    ) );
 
    if ( isset( $user_groups[ $group_id ] ) ) {
        $is_banned = $user_groups[ $group_id ]->id;
    }
 
    return $is_banned;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.0.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/bp-groups-functions.php: bp_get_user_groups()	Get a list of groups of which the specified user is a member.

Used By
Used By	Description
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: BP_REST_Group_Membership_Endpoint::create_item_permissions_check()	Checks if a given request has access to join a group.
bp-forums/functions.php: bbp_group_is_banned()	Is the current user banned from the current group
bp-groups/actions/join.php: groups_action_join_group()	Catch and process “Join Group” button clicks.
bp-groups/classes/class-bp-groups-group.php: BP_Groups_Group::get_group_extras()	Fetch extra data for a list of groups.
bp-groups/bp-groups-activity.php: bp_groups_filter_activity_can_comment()	Function used to determine if a user can comment on a group activity item.
bp-groups/bp-groups-template.php: bp_group_is_user_banned()	Check if a user is banned from a group.
bp-groups/bp-groups-filters.php: bp_groups_user_can_filter()	Filter the bp_user_can value to determine what the user can do with regards to a specific group.
bp-friends/bp-friends-functions.php: friends_get_friends_invite_list()	Get a list of friends that a user can invite into this group.
bp-friends/classes/class-bp-friends-friendship.php: BP_Friends_Friendship::get_invitable_friend_count()	Get a count of a user’s friends who can be invited to a given group.
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.
bp-activity/bp-activity-functions.php: bp_activity_user_can_read()	Can a user see a particular activity item?

Show 6 more used by Hide more used by

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