Contents

Code Reference Functions friends_get_total_friend_count()

friends_get_total_friend_count( int $user_id )

Get the friend count of a given user.

Description

Parameters

$user_id

(Required) ID of the user whose friends are being counted.

Return

(int) Connection count of the user.

Source

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

function friends_get_total_friend_count( $user_id = 0 ) {
	if ( empty( $user_id ) )
		$user_id = ( bp_displayed_user_id() ) ? bp_displayed_user_id() : bp_loggedin_user_id();

	$count = bp_get_user_meta( $user_id, 'total_friend_count', true );
	if ( empty( $count ) )
		$count = 0;

	/**
	 * Filters the total friend count for a given user.
	 *
	 * @since BuddyPress 1.2.0
	 *
	 * @param int $count Total friend count for a given user.
	 */
	return apply_filters( 'friends_get_total_friend_count', $count );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.2.0 Introduced.
Used By
Used By Description
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-friends/bp-friends-functions.php: friends_check_user_has_friends()

Check whether a given user has any friends.
bp-friends/bp-friends-template.php: bp_get_total_friend_count()

Return the total friend count for a given user.
bp-friends/bp-friends-template.php: bp_friends_get_profile_stats()

Return the number of friends in user’s profile.
bp-friends/classes/class-bp-friends-component.php: BP_Friends_Component::setup_nav()

Set up component navigation.
bp-core/classes/class-bp-email-tokens.php: BP_Email_Tokens::token__member_card_small()

Generate the output for token member.card
Show 1 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.