BBP_Shortcodes::display_topic_index()

Display an index of all visible root level topics in an output buffer and return to ensure that post/page contents are displayed first.

Description

Parameters

$attr: (Required)
$content: (Required)

Return

(string)

Source

File: bp-forums/common/shortcodes.php

public function display_topic_index() {
 
    // Unset globals
    $this->unset_globals();
 
    // Filter the query
    if ( ! bbp_is_topic_archive() ) {
        add_filter( 'bbp_before_has_topics_parse_args', array( $this, 'display_topic_index_query' ) );
    }
 
    // Start output buffer
    $this->start( 'bbp_topic_archive' );
 
    // Output template
    bbp_get_template_part( 'content', 'archive-topic' );
 
    // Return contents of output buffer
    return $this->end();
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r3031)	Introduced.

Uses

Uses
Uses	Description
bp-forums/core/template-functions.php: bbp_get_template_part()	Adds Forums theme support to any active WordPress theme
bp-forums/common/shortcodes.php: BBP_Shortcodes::unset_globals()	Unset some globals in the $bbp object that hold query related info
bp-forums/common/shortcodes.php: BBP_Shortcodes::start()	Start an output buffer.
bp-forums/common/shortcodes.php: BBP_Shortcodes::end()	Return the contents of the output buffer and flush its contents.
bp-forums/common/template.php: bbp_is_topic_archive()	Check if we are viewing a topic archive.

Used By
Used By	Description
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.

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