bp_group_get_media_status( int|bool $group_id = false )
Get the media status of a group.
Description
This function can be used either in or out of the loop.
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
Return
(bool|string) Returns false when no group can be found. Otherwise returns the group album status, from among 'members', 'mods', and 'admins'.
Source
File: bp-groups/bp-groups-template.php
function bp_group_get_media_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; } } $media_status = groups_get_groupmeta( $group_id, 'media_status' ); // Backward compatibility. When 'media_status' is not set, fall back to a default value. if ( !$media_status ) { $media_status = apply_filters( 'bp_group_media_status_fallback', 'members' ); } /** * Filters the album status of a group. * * Invite status in this case means who from the group can send invites. * * @since BuddyBoss 1.0.0 * * @param string $media_status Membership level needed to manage albums. * @param int $group_id ID of the group whose status is being checked. */ return apply_filters( 'bp_group_get_media_status', $media_status, $group_id ); }
Changelog
Version | Description |
---|---|
BuddyBoss 1.0.0 | Introduced. |
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.