Contents

Code Reference Functions friends_add_friend()

friends_add_friend( int $initiator_userid, int $friend_userid, bool $force_accept = false )

Create a new friendship.

Description

Parameters

$initiator_userid

(Required) ID of the "initiator" user (the user who is sending the friendship request).

$friend_userid

(Required) ID of the "friend" user (the user whose friendship is being requested).

$force_accept

(Optional) Whether to force acceptance. When false, running friends_add_friend() will result in a connection request. When true, running friends_add_friend() will result in an accepted friendship, with no notifications being sent. Default: false.

Default value: false

Return

(bool) True on success, false on failure.

Source

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

32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
function friends_add_friend( $initiator_userid, $friend_userid, $force_accept = false ) {
 
    // You cannot be friends with yourself!
    if ( $initiator_userid == $friend_userid ) {
        return false;
    }
 
    // Check if already friends, and bail if so.
    if ( friends_check_friendship( $initiator_userid, $friend_userid ) ) {
        return true;
    }
 
    // Setup the friendship data.
    $friendship = new BP_Friends_Friendship;
    $friendship->initiator_user_id = (int) $initiator_userid;
    $friendship->friend_user_id    = (int) $friend_userid;
    $friendship->is_confirmed      = 0;
    $friendship->is_limited        = 0;
    $friendship->date_created      = bp_core_current_time();
 
    if ( ! empty( $force_accept ) ) {
        $friendship->is_confirmed = 1;
    }
 
    // Bail if friendship could not be saved (how sad!).
    if ( ! $friendship->save() ) {
        return false;
    }
 
    // Send notifications.
    if ( empty( $force_accept ) ) {
        $action = 'requested';
 
    // Update friend totals.
    } else {
        $action = 'accepted';
        friends_update_friend_totals( $friendship->initiator_user_id, $friendship->friend_user_id, 'add' );
    }
 
    /**
     * Fires at the end of initiating a new friendship connection.
     *
     * This is a variable hook, depending on context.
     * The two potential hooks are: friends_friendship_requested, friends_friendship_accepted.
     *
     * @since BuddyPress 1.0.0
     *
     * @param int    $id                ID of the pending friendship connection.
     * @param int    $initiator_user_id ID of the friendship initiator.
     * @param int    $friend_user_id    ID of the friend user.
     * @param object $friendship        BuddyPress Friendship Object.
     */
    do_action( 'friends_friendship_' . $action, $friendship->id, $friendship->initiator_user_id, $friendship->friend_user_id, $friendship );
 
    return true;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.0.0 Introduced.

Uses

Uses
Uses Description
bp-friends/bp-friends-functions.php: friends_update_friend_totals()

Update user friend counts.
bp-friends/bp-friends-functions.php: friends_check_friendship()

Check whether two users are friends.
bp-friends/bp-friends-functions.php: friends_friendship_{$action}

Fires at the end of initiating a new friendship connection.
bp-friends/classes/class-bp-friends-friendship.php: BP_Friends_Friendship::__construct()

Constructor method.
bp-core/bp-core-functions.php: bp_core_current_time()

Get the current GMT time to save into the DB.
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/actions/add-friend.php: friends_action_add_friend()

Catch and process connection requests.
bp-templates/bp-nouveau/includes/friends/ajax.php: bp_nouveau_ajax_addremove_friend()

Friend/un-friend a user via a POST request.
bp-core/bp-core-tools-default-data.php: bp_dd_import_users_friends()

Get random users from the DB and generate member connections.

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.