Contents

Code Reference Functions groups_uninvite_user()

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

Uninvite a user from a group.

Description

Functionally, this is equivalent to removing a user from a group.

Parameters

$user_id

(Required) ID of the user.

$group_id

(Required) ID of the group.

$inviter_id

(Optional) ID of the inviter.

Default value: false

Return

(bool) True on success, false on failure.

Source

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

1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
function groups_uninvite_user( $user_id, $group_id ) {
 
    if ( ! BP_Groups_Member::delete_invite( $user_id, $group_id ) )
        return false;
 
    /**
     * Fires after uninviting a user from a group.
     *
     * @since BuddyPress 1.0.0
     *
     * @param int $group_id ID of the group being uninvited from.
     * @param int $user_id  ID of the user being uninvited.
     */
    do_action( 'groups_uninvite_user', $group_id, $user_id );
 
    return true;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.0.0 Introduced.
Used By
Used By Description
bp-groups/classes/class-bp-rest-group-invites-endpoint.php: BP_REST_Group_Invites_Endpoint::delete_item()

Remove (reject/delete) a group invitation.
bp-groups/actions/leave-group.php: groups_action_clean_up_invites_requests()

Clean up requests/invites when a member leaves a group.
bp-groups/screens/single/invite.php: groups_remove_group_invite()

Process group invitation removal requests.
bp-groups/actions/create.php: groups_action_create_group()

Catch and process group creation form submissions.
bp-templates/bp-nouveau/includes/groups/ajax.php: bp_nouveau_ajax_remove_group_invite()

AJAX remove group invite.

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.