bp_get_displayed_user_mentionname

Filters the mentionname for the displayed user.

Description

apply_filters( 'bp_get_displayed_user_mentionname', (string) $bp_activity_get_user_mentionname ); 

Parameters (1)

0. $bp_activity_get_user_mentionname (string) => bp_activity_get_user_mentionname( bp_displayed_user_id() )
The mentionanme for the displayed user.

Usage

To run the hook, copy the example below.
  1. $bp_activity_get_user_mentionname = apply_filters( 'bp_get_displayed_user_mentionname', $bp_activity_get_user_mentionname ); 
  2.  
  3. if ( !empty( $bp_activity_get_user_mentionname ) ) { 
  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_displayed_user_mentionname callback 
  2. function filter_bp_get_displayed_user_mentionname( $bp_activity_get_user_mentionname ) { 
  3. // make filter magic happen here... 
  4. return $bp_activity_get_user_mentionname
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_get_displayed_user_mentionname', 'filter_bp_get_displayed_user_mentionname', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_get_displayed_user_mentionname', 'filter_bp_get_displayed_user_mentionname', 10, 1 ); 

Defined (1)

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

/bp-activity/bp-activity-template.php  
  1. return apply_filters( 'bp_get_displayed_user_mentionname', bp_activity_get_user_mentionname( bp_displayed_user_id() ) );