groups_is_user_banned( int $user_id, int $group_id )

Check whether a user is banned from a given group.

Parameters Parameters


(int) (Required) ID of the user.


(int) (Required) ID of the group.

Top ↑

Return Return

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

Source Source

File: bp-groups/bp-groups-functions.php

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;

Top ↑

Changelog Changelog

Version Description
1.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.