*
* @param string $type Filename without extension.
* @param array $templates An optional list of template candidates
- * @return string Full path to file.
+ * @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");
- return apply_filters( "{$type}_template", locate_template( $templates ) );
+ $template = locate_template( $templates );
+ /**
+ * Filter the path of the queried template by type.
+ *
+ * The dynamic portion of the hook name, `$type`, refers to the filename
+ * -- minus the extension -- of the file to load. This hook also applies
+ * to various types of files loaded as part of the Template Hierarchy.
+ *
+ * @since 1.5.0
+ *
+ * @param string $template Path to the template. See {@see locate_template()}.
+ */
+ return apply_filters( "{$type}_template", $template );
}
/**
* Retrieve path of index template in current or parent template.
*
+ * The template path is filterable via the 'index_template' hook.
+ *
* @since 3.0.0
*
- * @return string
+ * @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 path is filterable via the '404_template' hook.
+ *
* @since 1.5.0
*
- * @return string
+ * @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 path is filterable via the 'archive_template' hook.
+ *
* @since 1.5.0
*
- * @return string
+ * @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' ) );
return get_query_template( 'archive', $templates );
}
+/**
+ * Retrieve path of post type archive template in current or parent template.
+ *
+ * The template path is filterable via the 'archive_template' hook.
+ *
+ * @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->has_archive )
+ return '';
+
+ return get_archive_template();
+}
+
/**
* Retrieve path of author template in current or parent template.
*
+ * The template path is filterable via the 'author_template' hook.
+ *
* @since 1.5.0
*
- * @return string
+ * @see get_query_template()
+ *
+ * @return string Full path to author template file.
*/
function get_author_template() {
$author = get_queried_object();
$templates = array();
- if ( $author ) {
+ if ( $author instanceof WP_User ) {
$templates[] = "author-{$author->user_nicename}.php";
$templates[] = "author-{$author->ID}.php";
}
* trying category ID, for example 'category-1.php', and will finally fall back to category.php
* template, if those files don't exist.
*
+ * The template path is filterable via the 'category_template' hook.
+ *
* @since 1.5.0
- * @uses apply_filters() Calls 'category_template' on file path of category template.
*
- * @return string
+ * @see get_query_template()
+ *
+ * @return string Full path to category template file.
*/
function get_category_template() {
$category = get_queried_object();
$templates = array();
- if ( $category ) {
+ if ( ! empty( $category->slug ) ) {
$templates[] = "category-{$category->slug}.php";
$templates[] = "category-{$category->term_id}.php";
}
* trying tag ID, for example 'tag-1.php', and will finally fall back to tag.php
* template, if those files don't exist.
*
+ * The template path is filterable via the 'tag_template' hook.
+ *
* @since 2.3.0
- * @uses apply_filters() Calls 'tag_template' on file path of tag template.
*
- * @return string
+ * @see get_query_template()
+ *
+ * @return string Full path to tag template file.
*/
function get_tag_template() {
$tag = get_queried_object();
$templates = array();
- if ( $tag ) {
+ if ( ! empty( $tag->slug ) ) {
$templates[] = "tag-{$tag->slug}.php";
$templates[] = "tag-{$tag->term_id}.php";
}
* template is used. If none of the files exist, then it will fall back on to
* index.php.
*
+ * The template path is filterable via the 'taxonomy_template' hook.
+ *
* @since 2.5.0
- * @uses apply_filters() Calls 'taxonomy_template' filter on found path.
*
- * @return string
+ * @see get_query_template()
+ *
+ * @return string Full path to taxonomy template file.
*/
function get_taxonomy_template() {
$term = get_queried_object();
$templates = array();
- if ( $term ) {
+ if ( ! empty( $term->slug ) ) {
$taxonomy = $term->taxonomy;
$templates[] = "taxonomy-$taxonomy-{$term->slug}.php";
$templates[] = "taxonomy-$taxonomy.php";
/**
* Retrieve path of date template in current or parent template.
*
+ * The template path is filterable via the 'date_template' hook.
+ *
* @since 1.5.0
*
- * @return string
+ * @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.
*
* This is the template used for the page containing the blog posts.
- *
* Attempts to locate 'home.php' first before falling back to 'index.php'.
*
+ * The template path is filterable via the 'home_template' hook.
+ *
* @since 1.5.0
- * @uses apply_filters() Calls 'home_template' on file path of home template.
*
- * @return string
+ * @see get_query_template()
+ *
+ * @return string Full path to home template file.
*/
function get_home_template() {
$templates = array( 'home.php', 'index.php' );
/**
* Retrieve path of front-page template in current or parent template.
*
- * Looks for 'front-page.php'.
+ * Looks for 'front-page.php'. The template path is filterable via the
+ * 'front_page_template' hook.
*
* @since 3.0.0
- * @uses apply_filters() Calls 'front_page_template' on file path of template.
*
- * @return string
+ * @see get_query_template()
+ *
+ * @return string Full path to front page template file.
*/
function get_front_page_template() {
$templates = array('front-page.php');
* Then will search for 'page-{slug}.php', followed by 'page-{id}.php',
* and finally 'page.php'.
*
+ * The template path is filterable via the 'page_template' hook.
+ *
* @since 1.5.0
*
- * @return string
+ * @see get_query_template()
+ *
+ * @return string Full path to page template file.
*/
function get_page_template() {
$id = get_queried_object_id();
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 ( $post )
+ $pagename = $post->post_name;
}
$templates = array();
/**
* Retrieve path of paged template in current or parent template.
*
+ * The template path is filterable via the 'paged_template' hook.
+ *
* @since 1.5.0
*
- * @return string
+ * @see get_query_template()
+ *
+ * @return string Full path to paged template file.
*/
function get_paged_template() {
return get_query_template('paged');
/**
* Retrieve path of search template in current or parent template.
*
+ * The template path is filterable via the 'search_template' hook.
+ *
* @since 1.5.0
*
- * @return string
+ * @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.
*
+ * The template path is filterable via the 'single_template' hook.
+ *
* @since 1.5.0
*
- * @return string
+ * @see get_query_template()
+ *
+ * @return string Full path to single template file.
*/
function get_single_template() {
$object = get_queried_object();
$templates = array();
- if ( $object )
+ if ( ! empty( $object->post_type ) )
$templates[] = "single-{$object->post_type}.php";
$templates[] = "single.php";
* Some examples for the 'text/plain' mime type are 'text.php', 'plain.php', and
* finally 'text_plain.php'.
*
+ * The template path is filterable via the 'attachment_template' hook.
+ *
* @since 2.0.0
*
- * @return string
+ * @see get_query_template()
+ *
+ * @return string Full path to attachment template file.
*/
function get_attachment_template() {
global $posts;
if ( ! empty( $type ) ) {
if ( $template = get_query_template( $type[0] ) )
return $template;
- elseif ( $template = get_query_template( $type[1] ) )
- return $template;
- elseif ( $template = get_query_template( "$type[0]_$type[1]" ) )
- return $template;
+ elseif ( ! empty( $type[1] ) ) {
+ if ( $template = get_query_template( $type[1] ) )
+ return $template;
+ elseif ( $template = get_query_template( "$type[0]_$type[1]" ) )
+ return $template;
+ }
}
}
* Checks for comment popup template in current template, if it exists or in the
* parent template.
*
+ * The template path is filterable via the 'comments_popup_template' hook.
+ *
* @since 1.5.0
- * @uses apply_filters() Calls 'comments_popup_template' filter on path.
*
- * @return string
+ * @see get_query_template()
+ *
+ * @return string Full path to comments popup template file.
*/
function get_comments_popup_template() {
$template = get_query_template( 'comments_popup', array( 'comments-popup.php' ) );
if ( file_exists(STYLESHEETPATH . '/' . $template_name)) {
$located = STYLESHEETPATH . '/' . $template_name;
break;
- } else if ( file_exists(TEMPLATEPATH . '/' . $template_name) ) {
+ } elseif ( file_exists(TEMPLATEPATH . '/' . $template_name) ) {
$located = TEMPLATEPATH . '/' . $template_name;
break;
}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff