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.
- $name = apply_filters( 'bp_get_mentioned_user_display_name', $name, $user_id_or_username );
- if ( !empty( $name ) ) {
- // everything has led up to this point...
- }
- The following example is for adding a hook callback.
- // define the bp_get_mentioned_user_display_name callback
- function filter_bp_get_mentioned_user_display_name( $name, $user_id_or_username ) {
- // make filter magic happen here...
- return $name;
- };
- // add the filter
- 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.
- // remove the filter
- 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
- return apply_filters( 'bp_get_mentioned_user_display_name', $name, $user_id_or_username );