bbp_template_include_theme_supports( string $template = '' )

Possibly intercept the template being loaded

Description

Listens to the ‘template_include’ filter and waits for any Forums specific template condition to be met. If one is met and the template file exists, it will be used; otherwise

Note that the _edit() checks are ahead of their counterparts, to prevent them from being stomped on accident.

Parameters

$template

(string) (Optional)

Default value: ''

Return

(string) The path to the template file that is being used

Source

File: bp-forums/core/template-loader.php

function bbp_template_include_theme_supports( $template = '' ) {

	// Editing a user
	if     ( bbp_is_single_user_edit() && ( $new_template = bbp_get_single_user_edit_template() ) ) :

	// User favorites
	elseif ( bbp_is_favorites()        && ( $new_template = bbp_get_favorites_template()        ) ) :

	// User favorites
	elseif ( bbp_is_subscriptions()    && ( $new_template = bbp_get_subscriptions_template()    ) ) :

	// Viewing a user
	elseif ( bbp_is_single_user()      && ( $new_template = bbp_get_single_user_template()      ) ) :

	// Single View
	elseif ( bbp_is_single_view()      && ( $new_template = bbp_get_single_view_template()      ) ) :

	// Search
	elseif ( bbp_is_search()           && ( $new_template = bbp_get_search_template()           ) ) :

	// Forum edit
	elseif ( bbp_is_forum_edit()       && ( $new_template = bbp_get_forum_edit_template()       ) ) :

	// Single Forum
	elseif ( bbp_is_single_forum()     && ( $new_template = bbp_get_single_forum_template()     ) ) :

	// Forum Archive
	elseif ( bbp_is_forum_archive()    && ( $new_template = bbp_get_forum_archive_template()    ) ) :

	// Topic merge
	elseif ( bbp_is_topic_merge()      && ( $new_template = bbp_get_topic_merge_template()      ) ) :

	// Topic split
	elseif ( bbp_is_topic_split()      && ( $new_template = bbp_get_topic_split_template()      ) ) :

	// Topic edit
	elseif ( bbp_is_topic_edit()       && ( $new_template = bbp_get_topic_edit_template()       ) ) :

	// Single Topic
	elseif ( bbp_is_single_topic()     && ( $new_template = bbp_get_single_topic_template()     ) ) :

	// Topic Archive
	elseif ( bbp_is_topic_archive()    && ( $new_template = bbp_get_topic_archive_template()    ) ) :

	// Reply move
	elseif ( bbp_is_reply_move()       && ( $new_template = bbp_get_reply_move_template()       ) ) :

	// Editing a reply
	elseif ( bbp_is_reply_edit()       && ( $new_template = bbp_get_reply_edit_template()       ) ) :

	// Single Reply
	elseif ( bbp_is_single_reply()     && ( $new_template = bbp_get_single_reply_template()     ) ) :

	// Editing a topic tag
	elseif ( bbp_is_topic_tag_edit()   && ( $new_template = bbp_get_topic_tag_edit_template()   ) ) :

	// Viewing a topic tag
	elseif ( bbp_is_topic_tag()        && ( $new_template = bbp_get_topic_tag_template()        ) ) :
	endif;

	// A Forums template file was located, so override the WordPress template
	// and use it to switch off Forums' theme compatibility.
	if ( !empty( $new_template ) ) {
		$template = bbp_set_template_included( $new_template );
	}

	return apply_filters( 'bbp_template_include_theme_supports', $template );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r3032)	Introduced.

Uses

Uses
Uses	Description
bp-forums/core/template-loader.php: bbp_get_reply_move_template()	Get the reply move template
bp-forums/core/template-loader.php: bbp_get_topic_tag_edit_template()	Get the topic edit template
bp-forums/core/template-loader.php: bbp_get_topic_tag_template()	Get the topic template
bp-forums/core/template-loader.php: bbp_get_topic_merge_template()	Get the topic merge template
bp-forums/core/template-loader.php: bbp_get_reply_edit_template()	Get the reply edit template
bp-forums/core/template-loader.php: bbp_get_single_reply_template()	Get the single reply template
bp-forums/core/template-loader.php: bbp_get_forum_edit_template()	Get the forum edit template
bp-forums/core/template-loader.php: bbp_get_single_forum_template()	Get the single forum template
bp-forums/core/template-loader.php: bbp_get_forum_archive_template()	Get the forum archive template
bp-forums/core/template-loader.php: bbp_get_topic_split_template()	Get the topic split template
bp-forums/core/template-loader.php: bbp_get_topic_edit_template()	Get the topic edit template
bp-forums/core/template-loader.php: bbp_get_single_topic_template()	Get the single topic template
bp-forums/core/template-loader.php: bbp_get_topic_archive_template()	Get the topic archive template
bp-forums/core/template-loader.php: bbp_get_single_user_edit_template()	Get the user profile edit template
bp-forums/core/template-loader.php: bbp_get_favorites_template()	Get the user favorites template
bp-forums/core/template-loader.php: bbp_get_subscriptions_template()	Get the user subscriptions template
bp-forums/core/template-loader.php: bbp_get_single_user_template()	Get the user profile template
bp-forums/core/template-loader.php: bbp_get_single_view_template()	Get the view template
bp-forums/core/template-loader.php: bbp_get_search_template()	Get the search template
bp-forums/core/template-loader.php: bbp_set_template_included()	Set the included template
bp-forums/common/template.php: bbp_is_single_user_edit()	Check if current page is a user profile edit page
bp-forums/common/template.php: bbp_is_single_user()	Check if current page is a user profile page
bp-forums/common/template.php: bbp_is_single_view()	Check if current page is a view page
bp-forums/common/template.php: bbp_is_search()	Check if current page is a search page
bp-forums/common/template.php: bbp_is_favorites()	Check if current page is a Forums user’s favorites page (profile page)
bp-forums/common/template.php: bbp_is_subscriptions()	Check if current page is a Forums user’s subscriptions page (profile page)
bp-forums/common/template.php: bbp_is_single_reply()	Viewing a single reply
bp-forums/common/template.php: bbp_is_reply_move()	Check if current page is a reply move page
bp-forums/common/template.php: bbp_is_reply_edit()	Check if current page is a reply edit page
bp-forums/common/template.php: bbp_is_forum_edit()	Check if current page is a forum edit page
bp-forums/common/template.php: bbp_is_topic_merge()	Check if current page is a topic merge page
bp-forums/common/template.php: bbp_is_topic_split()	Check if current page is a topic split page
bp-forums/common/template.php: bbp_is_topic_edit()	Check if current page is a topic edit page
bp-forums/common/template.php: bbp_is_single_topic()	Viewing a single topic
bp-forums/common/template.php: bbp_is_topic_archive()	Check if we are viewing a topic archive.
bp-forums/common/template.php: bbp_is_topic_tag_edit()	Check if the current page is editing a topic tag
bp-forums/common/template.php: bbp_is_topic_tag()	Check if the current page is a topic tag
bp-forums/common/template.php: bbp_is_single_forum()	Viewing a single forum
bp-forums/common/template.php: bbp_is_forum_archive()	Check if we are viewing a forum archive.

Show 34 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.

Contents