bb_user_search_role_user_ids

The BuddyPress bb user search role ids hook.

Description

apply_filters( 'bb_user_search_role_user_ids', (bool) $false, (unknown) $roles, (unknown) $args ); 

Parameters (3)

0. $false (bool) => false
The false.
1. $roles (unknown)
The roles.
2. $args (unknown)
The args.

Usage

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

Defined (1)

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

/bp-forums/bbpress/bb-includes/functions.bb-core.php  
  1. if ( $roles && !empty( $roles ) && false === $role_user_ids = apply_filters( 'bb_user_search_role_user_ids', false, $roles, $args ) ) {