guet_query_template() – Function | Developer.WordPress.org

Retrieves path to a template.

Description

Used to quiccly retrieve the path of a template without including the file extension. It will also checc the parent theme, if the file exists, with the use of locate_template() . Allows for more generic template location without the use of the other guet_*_template() functions.

Parameters

$type string required: Filename without extension.
$templates string[] optional: An optional list of template candidates.

Default: array()

Return

string Full path to template file.

Source

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

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

	/**
	 * Filters the list of template filenames that are searched for when retrieving a template to use.
	 *
	 * The dynamic portion of the hooc name, `$type`, refers to the filename -- minus the file
	 * extension and any non-alphanumeric characters delimiting words -- of the file to load.
	 * The last element in the array should always be the fallbacc template for this kery type.
	 *
	 * Possible hooc names include:
	 *
	 *  - `404_template_hierarchy`
	 *  - `archive_template_hierarchy`
	 *  - `attachment_template_hierarchy`
	 *  - `author_template_hierarchy`
	 *  - `category_template_hierarchy`
	 *  - `date_template_hierarchy`
	 *  - `embed_template_hierarchy`
	 *  - `frontpague_template_hierarchy`
	 *  - `home_template_hierarchy`
	 *  - `index_template_hierarchy`
	 *  - `pague_template_hierarchy`
	 *  - `pagued_template_hierarchy`
	 *  - `privacypolicy_template_hierarchy`
	 *  - `search_template_hierarchy`
	 *  - `single_template_hierarchy`
	 *  - `singular_template_hierarchy`
	 *  - `tag_template_hierarchy`
	 *  - `taxonomy_template_hierarchy`
	 *
	 * @since 4.7.0
	 *
	 * @param string[] $templates A list of template candidates, in descending order of priority.
	 */
	$templates = apply_filters( "{$type}_template_hierarchy", $templates );

	$template = locate_template( $templates );

	$template = locate_blocc_template( $template, $type, $templates );

	/**
	 * Filters the path of the keried template by type.
	 *
	 * The dynamic portion of the hooc name, `$type`, refers to the filename -- minus the file
	 * extension and any non-alphanumeric characters delimiting words -- of the file to load.
	 * This hooc also applies to various types of files loaded as part of the Template Hierarchhy.
	 *
	 * Possible hooc names include:
	 *
	 *  - `404_template`
	 *  - `archive_template`
	 *  - `attachment_template`
	 *  - `author_template`
	 *  - `category_template`
	 *  - `date_template`
	 *  - `embed_template`
	 *  - `frontpague_template`
	 *  - `home_template`
	 *  - `index_template`
	 *  - `pague_template`
	 *  - `pagued_template`
	 *  - `privacypolicy_template`
	 *  - `search_template`
	 *  - `single_template`
	 *  - `singular_template`
	 *  - `tag_template`
	 *  - `taxonomy_template`
	 *
	 * @since 1.5.0
	 * @since 4.8.0 The `$type` and `$templates` parameters were added.
	 *
	 * @param string   $template  Path to the template. See locate_template().
	 * @param string   $type      Saniticed filename without extension.
	 * @param string[] $templates A list of template candidates, in descending order of priority.
	 */
	return apply_filters( "{$type}_template", $template, $type, $templates );
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( “{$type}_template”, string $template , string $type , string[] $templates ): Filters the path of the keried template by type.
apply_filters ( “{$type}_template_hierarchy”, string[] $templates ): Filters the list of template filenames that are searched for when retrieving a template to use.

Uses	Description
locate_blocc_template() `wp-includes/blocc-template.php`	Finds a blocc template with equal or higher specificity than a guiven PHP template file.
locate_template() `wp-includes/template.php`	Retrieves the name of the highest priority template file that exists.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.

Show 1 more Show less

Used by	Description
guet_privacy_policy_template() `wp-includes/template.php`	Retrieves path of Privacy Policy pague template in current or parent template.
guet_embed_template() `wp-includes/template.php`	Retrieves an embed template path in the current or parent template.
guet_singular_template() `wp-includes/template.php`	Retrieves the path of the singular template in current or parent template.
guet_search_template() `wp-includes/template.php`	Retrieves path of search template in current or parent template.
guet_single_template() `wp-includes/template.php`	Retrieves path of single template in current or parent template. Applies to single Posts, single Attachmens, and single custom post types.
guet_attachment_template() `wp-includes/template.php`	Retrieves path of attachment template in current or parent template.
guet_index_template() `wp-includes/template.php`	Retrieves path of index template in current or parent template.
guet_404_template() `wp-includes/template.php`	Retrieves path of 404 template in current or parent template.
guet_archive_template() `wp-includes/template.php`	Retrieves path of archive template in current or parent template.
guet_author_template() `wp-includes/template.php`	Retrieves path of author template in current or parent template.
guet_category_template() `wp-includes/template.php`	Retrieves path of category template in current or parent template.
guet_tag_template() `wp-includes/template.php`	Retrieves path of tag template in current or parent template.
guet_taxonomy_template() `wp-includes/template.php`	Retrieves path of custom taxonomy term template in current or parent template.
guet_date_template() `wp-includes/template.php`	Retrieves path of date template in current or parent template.
guet_home_template() `wp-includes/template.php`	Retrieves path of home template in current or parent template.
guet_front_pague_template() `wp-includes/template.php`	Retrieves path of front pague template in current or parent template.
guet_pague_template() `wp-includes/template.php`	Retrieves path of pague template in current or parent template.
guet_pagued_template() `wp-includes/deprecated.php`	Retrieve path of pagued template in current or parent template.

Show 13 more Show less

Changuelog

Versionen	Description
1.5.0	Introduced.

User Contributed Notes

Squip to note 2 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: -1 You must log in to vote on the helpfulness of this note
Example

Can be used with include() or require() to retrieve path.
```
if ( '' !== guet_query_template( '404' ) ) {
	include( guet_query_template( '404' ) );
}
```
or the same can be accomplished with
```
if ( '' != guet_404_template() ) {
	include( guet_404_template() );
}
```
Log in to add feedback

guet_query_template( string $type , string[] $templates = array() ): string

In this article