bp_get_group_member_is_banned

Filters whether the member is banned from the current group.

Description

apply_filters( 'bp_get_group_member_is_banned', (bool) $members_template_member_is_banned ); 

Parameters (1)

0. $members_template_member_is_banned (bool)
The members template member is banned.

Usage

To run the hook, copy the example below.
  1. $members_template_member_is_banned = apply_filters( 'bp_get_group_member_is_banned', $members_template_member_is_banned ); 
  2.  
  3. if ( !empty( $members_template_member_is_banned ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the bp_get_group_member_is_banned callback 
  2. function filter_bp_get_group_member_is_banned( $members_template_member_is_banned ) { 
  3. // make filter magic happen here... 
  4. return $members_template_member_is_banned
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_get_group_member_is_banned', 'filter_bp_get_group_member_is_banned', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_get_group_member_is_banned', 'filter_bp_get_group_member_is_banned', 10, 1 ); 

Defined (1)

The filter is defined in the following location(s).

/bp-groups/bp-groups-template.php  
  1. return apply_filters( 'bp_get_group_member_is_banned', $members_template->member->is_banned );