bp_group_get_document_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

(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_document_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;
        }
    }
 
    $document_status = groups_get_groupmeta( $group_id, 'document_status' );
 
    // Backward compatibility. When 'media_status' is not set, fall back to a default value.
    if ( ! $document_status ) {
        $document_status = apply_filters( 'bp_group_document_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_document_status', $document_status, $group_id );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyBoss 1.0.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/bp-groups-template.php: bp_group_get_document_status	Filters the album status of a group.
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.

Used By
Used By	Description
bp-document/bp-document-functions.php: bp_document_user_can_manage_document()	Check user have a permission to manage the document.
bp-groups/bp-groups-template.php: bp_group_show_document_status_setting()	Output the ‘checked’ value, if needed, for a given document_status on the group create/admin screens
bp-groups/bp-groups-functions.php: groups_can_user_manage_document()	Check whether a user is allowed to manage document in a given group.
bp-groups/bp-groups-functions.php: groups_can_user_manage_folders()	Check whether a user is allowed to manage albums in a given group.
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.

Show 2 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