friends_check_friendship_status( int $user_id, int $possible_friend_id )

Get the friendship status of two friends.

Description

Will return ‘is_friends’, ‘not_friends’, ‘pending’ or ‘awaiting_response’.

Parameters

$user_id: (Required) ID of the first user.
$possible_friend_id: (Required) ID of the other user.

Return

(string) Friend status of the two users.

Source

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

function friends_check_friendship_status( $user_id, $possible_friend_id ) {
	global $members_template;

	// Check the BP_User_Query first
	// @see bp_friends_filter_user_query_populate_extras().
	if ( ! empty( $members_template->in_the_loop ) ) {
		if ( isset( $members_template->member->friendship_status ) ) {
			return $members_template->member->friendship_status;
		}
	}

	return BP_Friends_Friendship::check_is_friend( $user_id, $possible_friend_id );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.2.0	Introduced.

Uses

Uses
Uses	Description
bp-friends/classes/class-bp-friends-friendship.php: BP_Friends_Friendship::check_is_friend()	Check friendship status between two users.

Used By
Used By	Description
bp-media/classes/class-bp-rest-media-endpoint.php: BP_REST_Media_Endpoint::bp_rest_check_privacy_restriction()	Check user access based on the privacy for the single Media.
bp-media/classes/class-bp-rest-media-albums-endpoint.php: BP_REST_Media_Albums_Endpoint::bp_rest_check_album_privacy_restriction()	Check user access based on the privacy for the single album.
bp-document/classes/class-bp-rest-document-folder-endpoint.php: BP_REST_Document_Folder_Endpoint::bp_rest_check_folder_privacy_restriction()	Check user access based on the privacy for the single folder.
bp-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::bp_rest_check_privacy_restriction()	Check user access based on the privacy for the single document.
bp-members/classes/class-bp-rest-members-endpoint.php: BP_REST_Members_Endpoint::user_data()	Method to facilitate fetching of user data.
bp-friends/classes/class-bp-rest-friends-endpoint.php: BP_REST_Friends_Endpoint::create_item()	Create a new friendship.
bp-xprofile/bp-xprofile-functions.php: bp_get_user_social_networks_urls()	Add social networks button to the member header area.
bp-friends/bp-friends-template.php: bp_is_friend()	Check whether a given user is a friend of the logged-in user.
bp-templates/bp-nouveau/includes/messages/ajax.php: bp_nouveau_ajax_search_recipients_exclude_non_friend()	Exclude members from messages suggestions list if require users to be connected before they can message each other

Show 4 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