bp_activity_get_user_mentionname( int|string $user_id )

Determine a user’s “mentionname”, the name used for that user in @-mentions.

Description

Parameters

$user_id: (int|string) (Required) ID of the user to get @-mention name for.

Return

(string) $mentionname User name appropriate for @-mentions.

Source

File: bp-xprofile/bp-xprofile-functions.php

function bp_activity_get_user_mentionname( $user_id ) {
	$mentionname = '';

	$userdata = bp_core_get_core_userdata( $user_id );

	if ( $userdata ) {
		if ( bp_is_username_compatibility_mode() ) {
			$mentionname = str_replace( ' ', '-', $userdata->user_login );
		} else {
			$mentionname = get_user_meta( $userdata->ID, 'nickname', true );
		}
	}

	return $mentionname;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.9.0	Introduced.

Uses

Uses
Uses	Description
bp-members/bp-members-functions.php: bp_core_get_core_userdata()	Fetch everything in the wp_users table for a user, without any usermeta.
bp-core/bp-core-functions.php: bp_is_username_compatibility_mode()	Are we running username compatibility mode?

Used By
Used By	Description
bp-settings/classes/class-bp-rest-account-settings-options-endpoint.php: BP_REST_Account_Settings_Options_Endpoint::get_notifications_fields()	Get Fields for the Notifications “Email Preferences”.
bp-members/classes/class-bp-rest-members-endpoint.php: BP_REST_Members_Endpoint::user_data()	Method to facilitate fetching of user data.
bp-groups/bp-groups-functions.php: bp_groups_prime_mentions_results()	Mentions results for groups.
bp-core/bp-core-adminbar.php: bp_wp_admin_bar_my_account_menu()	Add the “My Account” submenu items.
bp-friends/bp-friends-functions.php: bp_friends_prime_mentions_results()	Used by the Activity component’s @mentions to print a JSON list of the current user’s friends.
bp-core/classes/class-bp-email-tokens.php: BP_Email_Tokens::token__member_card_small()	Generate the output for token member.card
bp-core/classes/class-bp-members-suggestions.php: BP_Members_Suggestions::get_suggestions()	Find and return a list of username suggestions that match the query.
bp-activity/bp-activity-notifications.php: bp_activity_screen_notification_settings()	Add activity notifications settings to the notifications settings page.
bp-activity/bp-activity-filters.php: bp_activity_filter_mentions_scope()	Set up activity arguments for use with the ‘favorites’ scope.
bp-activity/classes/class-bp-activity-oembed-extension.php: BP_Activity_oEmbed_Extension::set_fallback_html()	Sets a custom `<blockquote>` for our oEmbed fallback HTML.
bp-activity/bp-activity-template.php: bp_get_displayed_user_mentionname()	Get the mentionname for the displayed user.

Show 6 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents