bbp_get_total_users

The bbPress bbp get total users hook.

Description

apply_filters( 'bbp_get_total_users', (int) $int_user_count_total_users ); 

Parameters (1)

0. $int_user_count_total_users (int) => (int) $user_count['total_users']
The int user count total users.

Usage

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

Defined (1)

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

/includes/users/functions.php  
  1. return apply_filters( 'bbp_get_total_users', (int) $user_count['total_users'] );