groups_check_has_invite_from_user( int $user_id, int $group_id, string $inviter_id = false, string $type = 'sent' )

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

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.

$inviter_id

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

Default value: false

$type

(Optional) Specify a user ID to limit to only invited from that user. Default: 'false'.

Default value: 'sent'

Return

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

Source

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

function groups_check_has_invite_from_user( $user_id, $group_id, $inviter_id = false, $type = 'sent' ) {
    if ( empty( $user_id ) || empty( $group_id ) ) {
        return false;
    }
 
    $args = array(
        'user_id'     => $user_id,
        'item_id'     => $group_id,
        'invite_sent' => 'sent',
    );
    if ( $inviter_id ) {
        $args['inviter_id'] = $inviter_id;
    }
    if ( $type === 'draft' || $type === 'all' ) {
        $args['invite_sent'] = $type;
    }
 
    $invites_class = new BP_Groups_Invitation_Manager();
 
    return $invites_class->invitation_exists( $args );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 5.0.0	BuddyPress 5.0.0
BuddyBoss 1.3.5	Introduced.

Uses

Uses
Uses	Description
bp-groups/classes/class-bp-groups-invitation-manager.php: BP_Groups_Invitation_Manager::__construct()	Construct parameters.

Used By
Used By	Description
bp-groups/classes/class-bp-groups-invitation-manager.php: BP_Groups_Invitation_Manager::allow_invitation()	Should this invitation be created?
bp-groups/bp-groups-functions.php: groups_check_user_has_invite()	Check to see whether a user has already been invited to a group.
bp-groups/bp-groups-functions.php: groups_is_user_invited()	Check whether a user has an outstanding invitation to a group.

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