bp_group_get_invite_status( int|bool $group_id = false )

Get the invite status of a group.

Description

‘invite_status’ became part of BuddyPress in BP 1.5. In order to provide backward compatibility with earlier installations, groups without a status set will default to ‘members’, ie all members in a group can send invitations. Filter ‘bp_group_invite_status_fallback’ to change this fallback behavior.

This function can be used either in or out of the loop.

Parameters

$group_id

(Optional) The ID of the group whose status you want to check. Default: the displayed group, or the current group in the loop.

Default value: false

Return

(bool|string) Returns false when no group can be found. Otherwise returns the group invite status, from among 'members', 'mods', and 'admins'.

Source

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

function bp_group_get_invite_status( $group_id = false ) {
    global $groups_template;
 
    if ( !$group_id ) {
        $bp = buddypress();
 
        if ( isset( $bp->groups->current_group->id ) ) {
            // Default to the current group first.
            $group_id = $bp->groups->current_group->id;
        } elseif ( isset( $groups_template->group->id ) ) {
            // Then see if we're in the loop.
            $group_id = $groups_template->group->id;
        } else {
            return false;
        }
    }
 
    $invite_status = groups_get_groupmeta( $group_id, 'invite_status' );
 
    // Backward compatibility. When 'invite_status' is not set, fall back to a default value.
    if ( !$invite_status ) {
        $invite_status = apply_filters( 'bp_group_invite_status_fallback', 'members' );
    }
 
    /**
     * Filters the invite status of a group.
     *
     * Invite status in this case means who from the group can send invites.
     *
     * @since BuddyPress 1.5.0
     *
     * @param string $invite_status Membership level needed to send an invite.
     * @param int    $group_id      ID of the group whose status is being checked.
     */
    return apply_filters( 'bp_group_get_invite_status', $invite_status, $group_id );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.5.0	Introduced.

Uses

Uses
Uses	Description
bp-loader.php: buddypress()	The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-groups/bp-groups-functions.php: groups_get_groupmeta()	Get a piece of group metadata.
bp-groups/bp-groups-template.php: bp_group_get_invite_status	Filters the invite status of a group.

Used By
Used By	Description
bp-groups/classes/class-bp-rest-group-settings-endpoint.php: BP_REST_Group_Settings_Endpoint::get_settings_fields()	Get Group Settings.
bp-groups/classes/class-bp-rest-group-settings-endpoint.php: BP_REST_Group_Settings_Endpoint::update_settings_fields()	Update Group settings.
bp-groups/bp-groups-admin.php: bp_groups_admin_edit_metabox_settings()	Markup for the single group’s Settings metabox.
bp-groups/bp-groups-template.php: bp_group_show_invite_status_setting()	Output the ‘checked’ value, if needed, for a given invite_status on the group create/admin screens
bp-groups/bp-groups-filters.php: bp_groups_user_can_filter()	Filter the bp_user_can value to determine what the user can do with regards to a specific 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