* Template loading functions.
* Retrieve path to a template
* Used to quickly retrieve the path of a template without including the file
* extension. It will also check 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 get_*_template() functions.
* @param string $type Filename without extension.
* @param array $templates An optional list of template candidates
* @return string Full path to template file.
function get_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 last element in the array should always be the fallback template for this query type.
* Possible values for `$type` include: 'index', '404', 'archive', 'author', 'category', 'tag', 'taxonomy', 'date',
* 'embed', 'home', 'frontpage', 'privacypolicy', 'page', 'paged', 'search', 'single', 'singular', and 'attachment'.
* @param array $templates A list of template candidates, in descending order of priority.
$templates = apply_filters( "{$type}_template_hierarchy", $templates );
$template = locate_template( $templates );
* Filters the path of the queried template by type.
* The dynamic portion of the hook name, `$type`, refers to the filename -- minus the file
* extension and any non-alphanumeric characters delimiting words -- of the file to load.
* This hook also applies to various types of files loaded as part of the Template Hierarchy.
* Possible values for `$type` include: 'index', '404', 'archive', 'author', 'category', 'tag', 'taxonomy', 'date',
* 'embed', 'home', 'frontpage', 'privacypolicy', 'page', 'paged', 'search', 'single', 'singular', and 'attachment'.
* @since 4.8.0 The `$type` and `$templates` parameters were added.
* @param string $template Path to the template. See locate_template().
* @param string $type Sanitized filename without extension.
* @param array $templates A list of template candidates, in descending order of priority.
return apply_filters( "{$type}_template", $template, $type, $templates );
* Retrieve path of index template in current or parent template.
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'index'.
* @see get_query_template()
* @return string Full path to index template file.
function get_index_template() {
return get_query_template( 'index' );
* Retrieve path of 404 template in current or parent template.
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is '404'.
* @see get_query_template()
* @return string Full path to 404 template file.
function get_404_template() {
return get_query_template( '404' );
* Retrieve path of archive template in current or parent template.
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'archive'.
* @see get_query_template()
* @return string Full path to archive template file.
function get_archive_template() {
$post_types = array_filter( (array) get_query_var( 'post_type' ) );
if ( count( $post_types ) == 1 ) {
$post_type = reset( $post_types );
$templates[] = "archive-{$post_type}.php";
$templates[] = 'archive.php';
return get_query_template( 'archive', $templates );
* Retrieve path of post type archive template in current or parent template.
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'archive'.
* @see get_archive_template()
* @return string Full path to archive template file.
function get_post_type_archive_template() {
$post_type = get_query_var( 'post_type' );
if ( is_array( $post_type ) ) {
$post_type = reset( $post_type );
$obj = get_post_type_object( $post_type );
if ( ! ( $obj instanceof WP_Post_Type ) || ! $obj->has_archive ) {
return get_archive_template();
* Retrieve path of author template in current or parent template.
* The hierarchy for this template looks like:
* 1. author-{nicename}.php
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'author'.
* @see get_query_template()
* @return string Full path to author template file.
function get_author_template() {
$author = get_queried_object();
if ( $author instanceof WP_User ) {
$templates[] = "author-{$author->user_nicename}.php";
$templates[] = "author-{$author->ID}.php";
$templates[] = 'author.php';
return get_query_template( 'author', $templates );
* Retrieve path of category template in current or parent template.
* The hierarchy for this template looks like:
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'category'.
* @since 4.7.0 The decoded form of `category-{slug}.php` was added to the top of the
* template hierarchy when the category slug contains multibyte characters.
* @see get_query_template()
* @return string Full path to category template file.
function get_category_template() {
$category = get_queried_object();
if ( ! empty( $category->slug ) ) {
$slug_decoded = urldecode( $category->slug );
if ( $slug_decoded !== $category->slug ) {
$templates[] = "category-{$slug_decoded}.php";
$templates[] = "category-{$category->slug}.php";
$templates[] = "category-{$category->term_id}.php";
$templates[] = 'category.php';
return get_query_template( 'category', $templates );
* Retrieve path of tag template in current or parent template.
* The hierarchy for this template looks like:
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'tag'.
* @since 4.7.0 The decoded form of `tag-{slug}.php` was added to the top of the
* template hierarchy when the tag slug contains multibyte characters.
* @see get_query_template()
* @return string Full path to tag template file.
function get_tag_template() {
$tag = get_queried_object();
if ( ! empty( $tag->slug ) ) {
$slug_decoded = urldecode( $tag->slug );
if ( $slug_decoded !== $tag->slug ) {
$templates[] = "tag-{$slug_decoded}.php";
$templates[] = "tag-{$tag->slug}.php";
$templates[] = "tag-{$tag->term_id}.php";
$templates[] = 'tag.php';
return get_query_template( 'tag', $templates );
* Retrieve path of custom taxonomy term template in current or parent template.
* The hierarchy for this template looks like:
* 1. taxonomy-{taxonomy_slug}-{term_slug}.php
* 2. taxonomy-{taxonomy_slug}.php
* 1. taxonomy-location-texas.php
* 2. taxonomy-location.php
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'taxonomy'.
* @since 4.7.0 The decoded form of `taxonomy-{taxonomy_slug}-{term_slug}.php` was added to the top of the
* template hierarchy when the term slug contains multibyte characters.
* @see get_query_template()
* @return string Full path to custom taxonomy term template file.
function get_taxonomy_template() {
$term = get_queried_object();
if ( ! empty( $term->slug ) ) {
$taxonomy = $term->taxonomy;
$slug_decoded = urldecode( $term->slug );
if ( $slug_decoded !== $term->slug ) {
$templates[] = "taxonomy-$taxonomy-{$slug_decoded}.php";
$templates[] = "taxonomy-$taxonomy-{$term->slug}.php";
$templates[] = "taxonomy-$taxonomy.php";
$templates[] = 'taxonomy.php';
return get_query_template( 'taxonomy', $templates );
* Retrieve path of date template in current or parent template.
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'date'.
* @see get_query_template()
* @return string Full path to date template file.
function get_date_template() {
return get_query_template( 'date' );
* Retrieve path of home template in current or parent template.
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'home'.
* @see get_query_template()
* @return string Full path to home template file.
function get_home_template() {
$templates = array( 'home.php', 'index.php' );
return get_query_template( 'home', $templates );
* Retrieve path of front page template in current or parent template.
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'frontpage'.
* @see get_query_template()
* @return string Full path to front page template file.
function get_front_page_template() {
$templates = array( 'front-page.php' );
return get_query_template( 'frontpage', $templates );
* Retrieve path of Privacy Policy page template in current or parent template.
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'privacypolicy'.
* @see get_query_template()
* @return string Full path to privacy policy template file.
function get_privacy_policy_template() {
$templates = array( 'privacy-policy.php' );
return get_query_template( 'privacypolicy', $templates );
* Retrieve path of page template in current or parent template.
* The hierarchy for this template looks like:
* 2. page-{page_name}.php
* 1. page-templates/full-width.php
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'page'.
* @since 4.7.0 The decoded form of `page-{page_name}.php` was added to the top of the
* template hierarchy when the page name contains multibyte characters.
* @see get_query_template()
* @return string Full path to page template file.
function get_page_template() {
$id = get_queried_object_id();
$template = get_page_template_slug();
$pagename = get_query_var( 'pagename' );
if ( ! $pagename && $id ) {
// If a static page is set as the front page, $pagename will not be set.
// Retrieve it from the queried object.
$post = get_queried_object();
$pagename = $post->post_name;
if ( $template && 0 === validate_file( $template ) ) {
$templates[] = $template;
$pagename_decoded = urldecode( $pagename );
if ( $pagename_decoded !== $pagename ) {
$templates[] = "page-{$pagename_decoded}.php";
$templates[] = "page-{$pagename}.php";
$templates[] = "page-{$id}.php";
$templates[] = 'page.php';
return get_query_template( 'page', $templates );
* Retrieve path of search template in current or parent template.
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'search'.
* @see get_query_template()
* @return string Full path to search template file.
function get_search_template() {
return get_query_template( 'search' );
* Retrieve path of single template in current or parent template. Applies to single Posts,
* single Attachments, and single custom post types.
* The hierarchy for this template looks like:
* 1. {Post Type Template}.php
* 2. single-{post_type}-{post_name}.php
* 3. single-{post_type}.php
* 1. templates/full-width.php
* 2. single-post-hello-world.php
* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
* and {@see '$type_template'} dynamic hooks, where `$type` is 'single'.
* @since 4.4.0 `single-{post_type}-{post_name}.php` was added to the top of the template hierarchy.
* @since 4.7.0 The decoded form of `single-{post_type}-{post_name}.php` was added to the top of the
* template hierarchy when the post name contains multibyte characters.
* @since 4.7.0 `{Post Type Template}.php` was added to the top of the template hierarchy.