bp_get_mentioned_user_display_name

Filters the mentioned user display name.

Description

apply_filters( 'bp_get_mentioned_user_display_name', (string) $name, (string) $user_id_or_username ); 

Parameters (2)

0. $name (string)
Display name for the mentioned user.
1. $user_id_or_username (string)
User ID or username use for query.

Usage

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

Defined (1)

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

/bp-activity/bp-activity-template.php  
  1. return apply_filters( 'bp_get_mentioned_user_display_name', $name, $user_id_or_username );