friends_withdraw_friendship( int $initiator_userid, int $friend_userid )

Withdraw a friendship request.

Parameters Parameters


(int) (Required) ID of the friendship initiator

  • this is the user who requested the friendship, and is doing the withdrawing.


(int) (Required) ID of the requested friend.

Top ↑

Return Return

(bool) True on success, false on failure.

Source Source

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

function friends_withdraw_friendship( $initiator_userid, $friend_userid ) {
	$friendship_id = BP_Friends_Friendship::get_friendship_id( $initiator_userid, $friend_userid );
	$friendship    = new BP_Friends_Friendship( $friendship_id, true, false );

	if ( empty( $friendship->is_confirmed ) && BP_Friends_Friendship::withdraw( $friendship_id ) ) {

		// @deprecated Since 1.9
		do_action_ref_array( 'friends_friendship_whithdrawn', array( $friendship_id, &$friendship ) );

		 * Fires after a friendship request has been withdrawn.
		 * @since 1.9.0
		 * @param int                   $friendship_id ID of the friendship.
		 * @param BP_Friends_Friendship $friendship    Friendship object. Passed by reference.
		do_action_ref_array( 'friends_friendship_withdrawn',  array( $friendship_id, &$friendship ) );

		return true;

	return false;

Top ↑

Changelog Changelog

Version Description
1.6.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.