bp_group_get_invite_status( int|bool $group_id = false )

Get the invite status of a group.


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


Top ↑

Parameters Parameters

$group_id

(int|bool) (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


Top ↑

Return Return

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


Source 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 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 );
}


Top ↑

Changelog Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.