<?php

/**

 * Template loading functions.

 *

 * @package WordPress

 * @subpackage Template

 */

/**

 * 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.

 *

 * @since 1.5.0

 *

 * @param string   $type      Filename without extension.

 * @param string[] $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 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.

	 * The last element in the array should always be the fallback template for this query type.

	 *

	 * Possible hook names include:

	 *

	 *  - `404_template_hierarchy`

	 *  - `archive_template_hierarchy`

	 *  - `attachment_template_hierarchy`

	 *  - `author_template_hierarchy`

	 *  - `category_template_hierarchy`

	 *  - `date_template_hierarchy`

	 *  - `embed_template_hierarchy`

	 *  - `frontpage_template_hierarchy`

	 *  - `home_template_hierarchy`

	 *  - `index_template_hierarchy`

	 *  - `page_template_hierarchy`

	 *  - `paged_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_block_template( $template, $type, $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 hook names include:

	 *

	 *  - `404_template`

	 *  - `archive_template`

	 *  - `attachment_template`

	 *  - `author_template`

	 *  - `category_template`

	 *  - `date_template`

	 *  - `embed_template`

	 *  - `frontpage_template`

	 *  - `home_template`

	 *  - `index_template`

	 *  - `page_template`

	 *  - `paged_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      Sanitized filename without extension.

	 * @param string[] $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'.

 *

 * @since 3.0.0

 *

 * @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'.

 *

 * @since 1.5.0

 *

 * @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'.

 *

 * @since 1.5.0

 *

 * @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' ) );

	$templates = array();

	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'.

 *

 * @since 3.7.0

 *

 * @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 '';

	}

	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

 * 2. author-{id}.php

 * 3. author.php

 *

 * An example of this is:

 *

 * 1. author-john.php

 * 2. author-1.php

 * 3. author.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'.

 *

 * @since 1.5.0

 *

 * @see get_query_template()

 *

 * @return string Full path to author template file.

 */

function get_author_template() {

	$author = get_queried_object();

	$templates = array();

	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:

 *

 * 1. category-{slug}.php

 * 2. category-{id}.php

 * 3. category.php

 *

 * An example of this is:

 *

 * 1. category-news.php

 * 2. category-2.php

 * 3. category.php

 *

 * 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 1.5.0

 * @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();

	$templates = array();

	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:

 *

 * 1. tag-{slug}.php

 * 2. tag-{id}.php

 * 3. tag.php

 *

 * An example of this is:

 *

 * 1. tag-wordpress.php

 * 2. tag-3.php

 * 3. tag.php

 *

 * 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 2.3.0

 * @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();

	$templates = array();

	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

 * 3. taxonomy.php

 *

 * An example of this is:

 *

 * 1. taxonomy-location-texas.php

 * 2. taxonomy-location.php

 * 3. taxonomy.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 2.5.0

 * @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();

	$templates = array();

	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'.

 *

 * @since 1.5.0

 *

 * @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'.

 *

 * @since 1.5.0

 *

 * @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'.

 *

 * @since 3.0.0

 *

 * @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'.

 *

 * @since 5.2.0

 *

 * @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:

 *

 * 1. {Page Template}.php

 * 2. page-{page_name}.php

 * 3. page-{id}.php