bp_get_group_total_members

Filters the total member count for a group.

Description

apply_filters( 'bp_get_group_total_members', (number) $group_total_member_count, (object) $group ); 

Parameters (2)

0. $group_total_member_count (number)
Total member count for a group.
1. $group (object)
Group object.

Usage

To run the hook, copy the example below.
  1. $group_total_member_count = apply_filters( 'bp_get_group_total_members', $group_total_member_count, $group ); 
  2.  
  3. if ( !empty( $group_total_member_count ) ) { 
  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_total_members callback 
  2. function filter_bp_get_group_total_members( $group_total_member_count, $group ) { 
  3. // make filter magic happen here... 
  4. return $group_total_member_count
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_get_group_total_members', 'filter_bp_get_group_total_members', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_get_group_total_members', 'filter_bp_get_group_total_members', 10, 2 ); 

Defined (1)

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

/bp-groups/bp-groups-template.php  
  1. return apply_filters( 'bp_get_group_total_members', $group->total_member_count, $group );