friends_friendship_deleted

Fires before the friendship connection is removed.

Description

do_action( 'friends_friendship_deleted', (int) $friendship_id, (int) $initiator_userid, (int) $friend_userid ); 

This hook is misleadingly named - the friendship is not yet deleted. This is your last chance to do something while the friendship exists.

Parameters (3)

0. $friendship_id (int)
ID of the friendship object, if any, between a pair of users.
1. $initiator_userid (int)
ID of the friendship initiator.
2. $friend_userid (int)
ID of the friend user.

Usage

To run the hook, copy the example below.
  1. // run the action 
  2. do_action( 'friends_friendship_deleted', $friendship_id, $initiator_userid, $friend_userid ); 
The following example is for adding a hook callback.
  1. // define the friends_friendship_deleted callback 
  2. function action_friends_friendship_deleted( $friendship_id, $initiator_userid, $friend_userid ) { 
  3. // make action magic happen here... 
  4. }; 
  5.  
  6. // add the action 
  7. add_action( 'friends_friendship_deleted', 'action_friends_friendship_deleted', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the action 
  2. remove_action( 'friends_friendship_deleted', 'action_friends_friendship_deleted', 10, 3 ); 

Defined (1)

The action is defined in the following location(s).

/bp-friends/bp-friends-functions.php  
  1. do_action( 'friends_friendship_deleted', $friendship_id, $initiator_userid, $friend_userid );