bp_get_parent_group_id( int|bool $group_id = false, int|bool $user_id = false, string $context = 'normal' )

Get the parent group ID for a specific group.

Description

To return the parent group regardless of visibility, leave the $user_id parameter empty. To return the parent only when visible to a specific user, specify a $user_id.

Parameters

$group_id

(Optional) ID of the group.

Default value: false

$user_id

(Optional) ID of a user to check group visibility for.

Default value: false

$context

(Optional) See bp_include_group_by_context() for description.

Default value: 'normal'

Return

(int) ID of parent group.

Source

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

function bp_get_parent_group_id( $group_id = false, $user_id = false, $context = 'normal' ) {
    if ( false === $group_id ) {
        $group_id = bp_get_current_group_id();
        if ( ! $group_id ) {
            // If we can't resolve the group_id, don't proceed.
            return 0;
        }
    }
 
    $group     = groups_get_group( $group_id );
    $parent_id = $group->parent_id;
 
    // If the user is specified, is the parent group visible to that user?
    // @TODO: This could make use of group visibility when available.
    if ( false !== $user_id && ! bp_user_can( $user_id, 'bp_moderate' ) ) {
        $parent_group = groups_get_group( $parent_id );
        if ( ! bp_include_group_by_context( $parent_group, $user_id, $context ) ) {
            $parent_id = 0;
        }
    }
 
    return (int) $parent_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-functions.php: groups_get_group()	Fetch a single group object.
bp-groups/bp-groups-template.php: bp_get_current_group_id()	Returns the ID of the current group.
bp-groups/bp-groups-template.php: bp_include_group_by_context()	Determine whether a group should be included in results sets for a user in a specific context.
bp-core/bp-core-caps.php: bp_user_can()	Check whether the specified user has a given capability on a given site.

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-groups-endpoint.php: BP_REST_Groups_Endpoint::bp_rest_user_can_join()	Check the group join with members type.
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: BP_REST_Group_Membership_Endpoint::bp_rest_get_group_potential_invites()	Get potential group invites.
bp-groups/bp-groups-admin.php: bp_groups_admin_edit_metabox_group_parent()	Markup for the single group’s Group Hierarchy metabox.
bp-groups/classes/class-bp-groups-component.php: BP_Groups_Component::setup_nav()	Set up component navigation.
bp-groups/bp-groups-template.php: bp_get_group_join_button()	Return button to join a group.
bp-templates/bp-nouveau/includes/groups/ajax.php: bp_nouveau_ajax_get_users_to_invite()	AJAX get list of members to invite to group.

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