BP_Friends_Friendship::get_friendship_id( int $user_id, int $friend_id )

Get the ID of the friendship object, if any, between a pair of users.

Description

Parameters

$user_id: (Required) The ID of the first user.
$friend_id: (Required) The ID of the second user.

Return

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

Source

File: bp-friends/classes/class-bp-friends-friendship.php

public static function get_friendship_id( $user_id, $friend_id ) {
    $friendship_id = null;
 
    // Can't friend yourself.
    if ( $user_id == $friend_id ) {
        return $friendship_id;
    }
 
    /*
     * Find friendships where the possible_friend_userid is the
     * initiator or friend.
     */
    $args = array(
        'initiator_user_id' => $friend_id,
        'friend_user_id'    => $friend_id
    );
    $result = self::get_friendships( $user_id, $args, 'OR' );
    if ( $result ) {
        $friendship_id = current( $result )->id;
    }
    return $friendship_id;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.0.0	Introduced.

Uses

Uses
Uses	Description
bp-friends/classes/class-bp-friends-friendship.php: BP_Friends_Friendship::get_friendships()	Get the friendships for a given user.

Used By
Used By	Description
bp-friends/classes/class-bp-rest-friends-endpoint.php: BP_REST_Friends_Endpoint::create_item()	Create a new friendship.
bp-friends/classes/class-bp-rest-friends-endpoint.php: BP_REST_Friends_Endpoint::delete_items()	Unfriend a friendship.
bp-friends/bp-friends-functions.php: friends_withdraw_friendship()	Withdraw a connection request.
bp-friends/bp-friends-functions.php: friends_get_friendship_id()	Get the ID of two users’ friendship, if it exists.
bp-friends/bp-friends-functions.php: friends_remove_friend()	Remove a friendship.

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