groups_delete_invite( int $user_id, int $group_id, int $inviter_id = false )
Delete a group invitation.
Description Description
Parameters Parameters
- $user_id
-
(Required) ID of the invited user.
- $group_id
-
(Required) ID of the group.
- $inviter_id
-
(Optional) ID of the inviter.
Default value: false
Return Return
(bool) True on success, false on failure.
Source Source
File: bp-groups/bp-groups-functions.php
function groups_delete_invite( $user_id, $group_id, $inviter_id = false ) { if ( empty( $user_id ) || empty( $group_id ) ) { return false; } $invites_class = new BP_Groups_Invitation_Manager(); $success = $invites_class->delete( array( 'user_id' => $user_id, 'item_id' => $group_id, 'inviter_id' => $inviter_id, ) ); /** * Fires after the deletion of a group invitation. * * @since 1.9.0 * @since 5.0.0 The $inviter_id arg was added. * * @param int $user_id ID of the user whose invitation is being deleted. * @param int $group_id ID of the group whose invitation is being deleted. * @param int $inviter_id ID of the inviter. */ do_action( 'groups_delete_invite', $user_id, $group_id, $inviter_id ); return true; }
Changelog Changelog
Version | Description |
---|---|
5.0.0 | The $inviter_id arg was added. |
1.0.0 | Introduced. |