Contents

Code Reference Functions bbp_is_forum_archive()

bbp_is_forum_archive()

Check if we are viewing a forum archive.

Description

Return

(bool)

Source

File: bp-forums/common/template.php

148
149
150
151
152
153
154
155
156
157
158
159
function bbp_is_forum_archive() {
    global $wp_query;
 
    // Default to false
    $retval = false;
 
    // In forum archive
    if ( is_post_type_archive( bbp_get_forum_post_type() ) || bbp_is_query_name( 'bbp_forum_archive' ) || !empty( $wp_query->bbp_show_topics_on_root ) || absint( $wp_query->get( 'page_id' ) ) === (int) bp_get_option('_bbp_root_slug_custom_slug') )
        $retval = true;
 
    return (bool) apply_filters( 'bbp_is_forum_archive', $retval );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r3251) Introduced.

Uses

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

Return the unique id of the custom post type for forums
bp-forums/common/template.php: bbp_is_query_name()

Check the passed parameter against the current _bbp_query_name
bp-core/bp-core-options.php: bp_get_option()

Retrieve an option.
Used By
Used By Description
bp-groups/bp-groups-filters.php: bp_groups_exclude_forums_by_group_type_args()

Exclude Forums from forum loop if any forum is attached to a group and that group have a group type and that group type is hidden from the directory page.
bp-groups/bp-groups-filters.php: bp_groups_exclude_forums_topics_by_group_type_args()

Exclude Forums topic from topic loop if any forum is attached to a group and that group have a group type and that group type is hidden from the directory page.
bp-forums/core/theme-compat.php: bbp_template_include_theme_compat()

Reset main query vars and filter ‘the_content’ to output a Forums template part as needed.
bp-forums/core/template-loader.php: bbp_template_include_theme_supports()

Possibly intercept the template being loaded
bp-forums/topics/template.php: bbp_has_topics()

The main topic loop. WordPress makes this easy for us
bp-forums/forums/template.php: bbp_has_forums()

The main forum loop.
bp-forums/common/template.php: bbp_title()

Custom page title for Forums pages
bp-forums/common/template.php: bbp_get_breadcrumb()

Return a breadcrumb ( forum -> topic -> reply )
bp-forums/common/template.php: is_bbpress()

Use the above is_() functions to return if in any Forums page
bp-forums/common/template.php: bbp_body_class()

Use the above is_() functions to output a body class for each scenario
Show 5 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.