bp_members_suggestions_get_suggestions

Filters the members suggestions results.

Description

apply_filters( 'bp_members_suggestions_get_suggestions', (array) $results, (BP_Members_Suggestions) $instance ); 

Parameters (2)

0. $results (array)
Array of users to suggest.
1. $instance (BP_Members_Suggestions)
Current BP_Members_Suggestions instance.

Usage

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

Defined (1)

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

/bp-core/classes/class-bp-members-suggestions.php  
  1. return apply_filters( 'bp_members_suggestions_get_suggestions', $results, $this );