bbp_find_mentions

The bbPress bbp find mentions hook.

Description

apply_filters( 'bbp_find_mentions', (string) $usernames, (unknown) $pattern, (unknown) $content ); 

Parameters (3)

0. $usernames (string)
The usernames.
1. $pattern (unknown)
The pattern.
2. $content (unknown)
The content.

Usage

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

Defined (1)

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

/includes/core/functions.php  
  1. return apply_filters( 'bbp_find_mentions', $usernames, $pattern, $content );