bbp_get_query_template( string $type, array $templates = array() )

Retrieve path to a template

Description

Used to quickly retrieve the path of a template without including the file extension. It will also check the parent theme and theme-compat theme with the use of bbp_locate_template(). Allows for more generic template locations without the use of the other get_*_template() functions.

Parameters

$type

(Required) Filename without extension.

$templates

(Optional) An optional list of template candidates

Default value: array()

Return

(string) Full path to file.

Source

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

function bbp_get_query_template( $type, $templates = array() ) {
	$type = preg_replace( '|[^a-z0-9-]+|', '', $type );

	if ( empty( $templates ) )
		$templates = array( "{$type}.php" );

	// Filter possible templates, try to match one, and set any Forums theme
	// compat properties so they can be cross-checked later.
	$templates = apply_filters( "bbp_get_{$type}_template", $templates );
	$templates = bbp_set_theme_compat_templates( $templates );
	$template  = bbp_locate_template( $templates );
	$template  = bbp_set_theme_compat_template( $template );

	return apply_filters( "bbp_{$type}_template", $template );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r3629)	Introduced.

Uses

Uses
Uses	Description
bp-forums/core/theme-compat.php: bbp_set_theme_compat_templates()	Set the theme compat templates global
bp-forums/core/theme-compat.php: bbp_set_theme_compat_template()	Set the theme compat template global
bp-forums/core/template-functions.php: bbp_locate_template()	Retrieve the name of the highest priority template file that exists.

Used By
Used By	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_template()	Get the topic 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_theme_compat_templates()	Get the templates to use as the endpoint for Forums template parts
bp-forums/core/template-loader.php: bbp_get_topic_merge_template()	Get the topic merge 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_reply_edit_template()	Get the reply 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_forum_edit_template()	Get the forum 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_topic_edit_template()	Get the topic edit 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_single_user_template()	Get the user profile 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_view_template()	Get the view template
bp-forums/core/template-loader.php: bbp_get_search_template()	Get the search template

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

Contents