bp_activity_mentioned_users

Filters the mentioned users.

Description

apply_filters( 'bp_activity_mentioned_users', (array) $mentioned_users ); 

Parameters (1)

0. $mentioned_users (array)
Associative array with user IDs as keys and usernames as values.

Usage

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

Defined (1)

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

/bp-activity/bp-activity-functions.php  
  1. return apply_filters( 'bp_activity_mentioned_users', $mentioned_users );