BP_Friends_Friendship::check_is_friend( int $initiator_userid, int $possible_friend_userid )

Check friendship status between two users.

Description

Note that ‘pending’ means that $initiator_userid has sent a friend request to $possible_friend_userid that has not yet been approved, while ‘awaiting_response’ is the other way around ($possible_friend_userid sent the initial request).

Parameters

$initiator_userid: (Required) The ID of the user who is the initiator of the potential friendship/request.
$possible_friend_userid: (Required) The ID of the user who is the recipient of the potential friendship/request.

Return

(string|false) $value The friendship status, from among 'not_friends', 'is_friend', 'pending', and 'awaiting_response'.

Source

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

	public static function check_is_friend( $initiator_userid, $possible_friend_userid ) {
		global $wpdb;

		if ( empty( $initiator_userid ) || empty( $possible_friend_userid ) ) {
			return false;
		}

		// Can't friend yourself.
		if ( $initiator_userid == $possible_friend_userid ) {
			return 'not_friends';
		}

		BP_Friends_Friendship::update_bp_friends_cache( $initiator_userid, $possible_friend_userid );

		return bp_core_get_incremented_cache( $initiator_userid . ':' . $possible_friend_userid, 'bp_friends' );
	}

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::update_bp_friends_cache()	Find uncached friendships between a user and one or more other users and cache them.
bp-core/bp-core-cache.php: bp_core_get_incremented_cache()	Gets a value that has been cached using an incremented key.

Used By
Used By	Description
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_check_friendship()	Check whether two users are friends.
bp-friends/bp-friends-functions.php: friends_check_friendship_status()	Get the friendship status of two friends.
bp-friends/actions/add-friend.php: friends_action_add_friend()	Catch and process connection requests.
bp-friends/actions/remove-friend.php: friends_action_remove_friend()	Catch and process Remove Connection requests.
bp-friends/bp-friends-filters.php: bp_friends_filter_user_query_populate_extras()	Filter BP_User_Query::populate_extras to add confirmed friendship status.
bp-templates/bp-nouveau/includes/friends/ajax.php: bp_nouveau_ajax_addremove_friend()	Friend/un-friend a user via a POST request.

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