bp_suggestions_services

Filters the default suggestions service to use.

Description

apply_filters( 'bp_suggestions_services', (string) $var, (array) $args ); 

Use this hook to tell BP the name of your class if you've built a custom suggestions service.

Parameters (2)

0. $var (string) => ''
Custom class to use. Default: none.
1. $args (array)
Array of arguments for sugggestions.

Usage

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

Defined (1)

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

/bp-core/bp-core-functions.php  
  1. $class = apply_filters( 'bp_suggestions_services', '', $args );