friends_get_friendship_id( int $initiator_user_id, int $friend_user_id )

Get the ID of two users’ friendship, if it exists.

Description

Parameters

$initiator_user_id: (Required) ID of the first user.
$friend_user_id: (Required) ID of the second user.

Return

(int|null) ID of the friendship if found, otherwise false.

Source

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

function friends_get_friendship_id( $initiator_user_id, $friend_user_id ) {
	return BP_Friends_Friendship::get_friendship_id( $initiator_user_id, $friend_user_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::get_friendship_id()	Get the ID of the friendship object, if any, between a pair of users.

Used By
Used By	Description
bp-members/classes/class-bp-rest-members-endpoint.php: BP_REST_Members_Endpoint::user_data()	Method to facilitate fetching of user data.
bp-friends/bp-friends-template.php: bp_get_friend_reject_request_link()	Return the URL for rejecting the current friendship request in the loop.
bp-friends/bp-friends-template.php: bp_get_friend_accept_request_link()	Return the URL for accepting the current friendship request in the loop.
bp-friends/bp-friends-template.php: bp_get_friend_friendship_id()	Return the ID of the friendship between the logged-in user and the current user in the loop.

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