groups_check_user_has_invite( int $user_id, int $group_id, string $type = 'sent' )

Check to see whether a user has already been invited to a group.

Description

By default, the function checks for invitations that have been sent. Entering ‘all’ as the $type parameter will return unsent invitations as well (useful to make sure AJAX requests are not duplicated).

Parameters

$user_id

(Required) ID of potential group member.

$group_id

(Required) ID of potential group.

$type

(Optional) Use 'sent' to check for sent invites, 'all' to check for all. Default: 'sent'.

Default value: 'sent'

Return

(int|bool) ID of the membership if found, otherwise false.

Source

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

function groups_check_user_has_invite( $user_id, $group_id, $type = 'sent' ) {
    $invite = false;
 
    $args = array(
        'is_confirmed' => false,
        'is_banned'    => null,
        'is_admin'     => null,
        'is_mod'       => null,
    );
 
    if ( 'sent' === $type ) {
        $args['invite_sent'] = true;
    }
 
    $user_groups = bp_get_user_groups( $user_id, $args );
 
    if ( isset( $user_groups[ $group_id ] ) && 0 !== $user_groups[ $group_id ]->inviter_id ) {
        $invite = $user_groups[ $group_id ]->id;
    }
 
    return $invite;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.0.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/bp-groups-functions.php: groups_check_has_invite_from_user()	Check to see whether a user has already been invited to a group by a particular user.

Used By
Used By	Description
bp-groups/actions/join.php: groups_action_join_group()	Catch and process “Join Group” button clicks.
bp-groups/classes/class-bp-groups-group.php: BP_Groups_Group::__get()	Magic getter.
bp-groups/bp-groups-functions.php: bp_groups_get_invited_by()	Get inviter for member’s group invitation
bp-groups/bp-groups-functions.php: bp_groups_get_invite_messsage_for_user()	Get user’s invite message.
bp-groups/bp-groups-functions.php: groups_send_membership_request()	Create a group membership request.
bp-groups/bp-groups-functions.php: groups_join_group()	Add a user to a group.
bp-friends/classes/class-bp-friends-friendship.php: BP_Friends_Friendship::get_invitable_friend_count()	Get a count of a user’s friends who can be invited to a given group.
bp-templates/bp-nouveau/includes/groups/ajax.php: bp_nouveau_ajax_joinleave_group()	Join or leave a group when clicking the “join/leave” button via a POST request.
bp-templates/bp-nouveau/includes/groups/functions.php: bp_nouveau_prepare_group_potential_invites_for_js()	Prepare list of group invites for JS.

Show 4 more used by Hide more used by

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.

Contents