bp_group_is_user_banned

Filters whether current user has been banned from current group in loop.

Description

apply_filters( 'bp_group_is_user_banned', (bool) $retval, (object) $group ); 

Parameters (2)

0. $retval (bool)

If user has been from current group.

1. $group (object)

Group object.

Usage

To run the hook, copy the example below.

$retval = apply_filters( 'bp_group_is_user_banned', $retval, $group ); 
                         
if ( !empty( $retval ) ) { 
                         
   // everything has led up to this point... 
                         
} 
  

The following example is for adding a hook callback.

// define the bp_group_is_user_banned callback 
function filter_bp_group_is_user_banned( $retval, $group ) { 
    // make filter magic happen here... 
    return $retval; 
}; 
         
// add the filter 
add_filter( 'bp_group_is_user_banned', 'filter_bp_group_is_user_banned', 10, 2 ); 

To remove a hook callback, use the example below.

// remove the filter 
remove_filter( 'bp_group_is_user_banned', 'filter_bp_group_is_user_banned', 10, 2 );