groups_delete_invite( int $user_id, int $group_id, int $inviter_id = false )

Delete a group invitation.

Description

Parameters

$user_id

(int) (Required) ID of the invited user.

$group_id

(int) (Required) ID of the group.

$inviter_id

(int) (Optional) ID of the inviter.

Default value: false

Return

(bool) True on success, false on failure.

Source

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

function groups_delete_invite( $user_id, $group_id ) {
	if ( ! BP_Groups_Member::delete_invite( $user_id, $group_id ) )
		return false;

	/**
	 * Fires after the deletion of a group invitation.
	 *
	 * @since BuddyPress 1.9.0
	 *
	 * @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.
	 */
	do_action( 'groups_delete_invite', $user_id, $group_id );

	return true;
}

Changelog

Changelog
Version Description
BuddyPress 5.0.0 The $inviter_id arg was added. BuddyPress 5.0.0 The $inviter_id arg was added.
BuddyPress 1.0.0 Introduced.

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.