BP_Groups_Member::delete_invite( int $user_id, int $group_id, int $inviter_id = false )

Delete an invitation, by specifying user ID and group ID.


Parameters Parameters

$user_id

(int) (Required) ID of the user.

$group_id

(int) (Required) ID of the group.

$inviter_id

(int) (Optional) ID of the inviter. Specify if you want to delete a specific invite. Leave false if you want to delete all invites to this group.

Default value: false


Top ↑

Return Return

(int) Number of records deleted.


Source Source

File: bp-groups/classes/class-bp-groups-member.php

	public static function delete_invite( $user_id, $group_id, $inviter_id = false ) {
		/**
		 * Fires before a group invitation is deleted.
		 *
		 * @since 2.6.0
		 * @since 5.0.0 Added $inviter_id
		 *
		 * @param int $user_id  ID of the user.
		 * @param int $group_id ID of the group.
		 * @param  int $inviter_id ID of the inviter.
		 */
		do_action( 'bp_groups_member_before_delete_invite', $user_id, $group_id, $inviter_id );

		return groups_delete_invite( $user_id, $group_id, $inviter_id );
	}


Top ↑

Changelog 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.