bp_core_get_suggestions

Filters the available type of at-mentions.

Description

apply_filters( 'bp_core_get_suggestions', (array|WP_Error) $retval, (array) $args ); 

Parameters (2)

0. $retval (array|WP_Error)
Array of results or WP_Error object.
1. $args (array)
Array of arguments for suggestions.

Usage

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

Defined (1)

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

/bp-core/bp-core-functions.php  
  1. return apply_filters( 'bp_core_get_suggestions', $retval, $args );