Contents

Code Reference Classes BP_REST_Forums_Endpoint BP_REST_Forums_Endpoint::get_sub_forums()

BP_REST_Forums_Endpoint::get_sub_forums( array $args )

Get sub forums.

Description

Parameters

$args

(Required) array for the parameters.

Return

(array|void)

Source

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

1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
public function get_sub_forums( $args ) {
    $sub_forums = bbp_forum_get_subforums( $args );
 
    if ( empty( $sub_forums ) ) {
        return;
    }
 
    $retval = array();
    foreach ( $sub_forums as $sub_forum ) {
        $retval[] = array(
            'id'    => $sub_forum->ID,
            'slug'  => $sub_forum->post_name,
            'title' => bbp_get_forum_title( $sub_forum->ID ),
            'count' => array(
                'topic' => bbp_get_forum_topic_count( $sub_forum->ID ),
                'reply' => bbp_get_forum_reply_count( $sub_forum->ID ),
            ),
            'link'  => bbp_get_forum_permalink( $sub_forum->ID ),
            'group' => (
                (
                    function_exists( 'bbp_is_forum_group_forum' )
                    && bbp_is_forum_group_forum( $sub_forum->ID )
                    && function_exists( 'groups_get_group' )
                )
                ? (
                    bbp_get_forum_group_ids( $sub_forum->ID )
                    ? groups_get_group( current( bbp_get_forum_group_ids( $sub_forum->ID ) ) )
                    : ''
                )
                : ''
            ),
        );
    }
 
    return $retval;
}

Expand full source code Collapse full source code

Uses

Uses
Uses Description
bp-forums/forums/template.php: bbp_get_forum_topic_count()

Return total topic count of a forum
bp-forums/forums/template.php: bbp_get_forum_reply_count()

Return total post count of a forum
bp-forums/forums/template.php: bbp_forum_get_subforums()

Return subforums of given forum
bp-forums/forums/template.php: bbp_get_forum_title()

Return the title of the forum
bp-forums/forums/template.php: bbp_get_forum_permalink()

Return the link to the forum
bp-forums/functions.php: bbp_is_forum_group_forum()

Return true if a forum is a group forum
bp-forums/functions.php: bbp_get_forum_group_ids()

Get group ID’s for a forum
bp-groups/bp-groups-functions.php: groups_get_group()

Fetch a single group object.
Show 3 more uses Hide more uses

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.