Contents

Code Reference Classes BP_REST_Groups_Endpoint BP_REST_Groups_Endpoint::bp_rest_get_sub_groups()

BP_REST_Groups_Endpoint::bp_rest_get_sub_groups( integer $parent_group_id )

Get sub groups id.

Description

Parameters

$parent_group_id

(Required) Group ID.

Return

(array)

Source

File: bp-groups/classes/class-bp-rest-groups-endpoint.php

1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
public function bp_rest_get_sub_groups( $parent_group_id ) {
    if ( empty( $parent_group_id ) ) {
        return array();
    }
 
    $user_id = bp_loggedin_user_id();
    $filter  = ( false !== $user_id && ! bp_user_can( $user_id, 'bp_moderate' ) );
 
    if ( function_exists( 'bp_include_group_by_context ' ) ) {
        $sub_groups = groups_get_groups(
            array(
                'parent_id'   => $parent_group_id,
                'fields'      => 'ids',
                'show_hidden' => true,
                'per_page'    => false,
                'page'        => false,
            )
        );
 
        // Reset parents array to rebuild for next round.
        $groups = array();
        foreach ( $sub_groups['groups'] as $group ) {
            if ( $filter ) {
                if ( bp_include_group_by_context( $group, $user_id, 'normal' ) ) {
                    $groups[] = $group->id;
                }
            } else {
                $groups[] = $group->id;
            }
        }
 
        return $groups;
        // buddypress support.
    } else {
        $sub_groups = groups_get_groups(
            array(
                'parent_id'   => $parent_group_id,
                'fields'      => 'ids',
                'show_hidden' => false,
                'per_page'    => false,
                'page'        => false,
            )
        );
 
        if ( ! empty( $sub_groups ) && isset( $sub_groups['groups'] ) && ! empty( $sub_groups['groups'] ) ) {
            return $sub_groups['groups'];
        }
    }
 
    return array();
}

Expand full source code Collapse full source code

Uses

Uses
Uses Description
bp-groups/bp-groups-functions.php: groups_get_groups()

Get a collection of groups, based on the parameters passed.
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-template.php: bp_loggedin_user_id()

Get the ID of the currently logged-in user.
bp-core/bp-core-caps.php: bp_user_can()

Check whether the specified user has a given capability on a given site.

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.