friends_before_friendship_delete
Fires before the deletion of a friendship activity item for the user who canceled the friendship.
Description
do_action( 'friends_before_friendship_delete', (int) $friendship_id, (int) $initiator_userid, (int) $friend_userid );
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.
- // run the action
- do_action( 'friends_before_friendship_delete', $friendship_id, $initiator_userid, $friend_userid );
- The following example is for adding a hook callback.
- // define the friends_before_friendship_delete callback
- function action_friends_before_friendship_delete( $friendship_id, $initiator_userid, $friend_userid ) {
- // make action magic happen here...
- };
- // add the action
- add_action( 'friends_before_friendship_delete', 'action_friends_before_friendship_delete', 10, 3 );
- To remove a hook callback, use the example below.
- // remove the action
- remove_action( 'friends_before_friendship_delete', 'action_friends_before_friendship_delete', 10, 3 );
Defined (1)
The action is defined in the following location(s).
- /bp-friends/bp-friends-functions.php
- do_action( 'friends_before_friendship_delete', $friendship_id, $initiator_userid, $friend_userid );