bb_user_search_description

The BuddyPress bb user search description hook.

Description

apply_filters( 'bb_user_search_description', (unknown) $sprintf, (unknown) $h2_search, (unknown) $h2_role, (unknown) $instance ); 

Parameters (4)

0. $sprintf (unknown) => sprintf( __( '%1$s%2$s' ), $h2_search, $h2_role )
The sprintf.
1. $h2_search (unknown)
The h2 search.
2. $h2_role (unknown)
The h2 role.
3. $instance (unknown)
The instance.

Usage

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

Defined (1)

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

/bp-forums/bbpress/bb-admin/includes/functions.bb-admin.php  
  1. $h2_span .= apply_filters( 'bb_user_search_description', sprintf( __( '%1$s%2$s' ), $h2_search, $h2_role ), $h2_search, $h2_role, $this );