]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/template.php
WordPress 4.2.5
[autoinstalls/wordpress.git] / wp-includes / template.php
index 531b308d247037cea68234ead01f89be4656f296..cfe9bb06aa8f3312b74c9962837fef730e9ca458 100644 (file)
@@ -18,7 +18,7 @@
  *
  * @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 );
@@ -26,15 +26,31 @@ function get_query_template( $type, $templates = array() ) {
        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');
@@ -43,9 +59,13 @@ function get_index_template() {
 /**
  * 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');
@@ -54,36 +74,71 @@ function get_404_template() {
 /**
  * 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_type = get_query_var( 'post_type' );
+       $post_types = array_filter( (array) get_query_var( 'post_type' ) );
 
        $templates = array();
 
-       if ( $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 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();
 
-       $templates[] = "author-{$author->user_nicename}.php";
-       $templates[] = "author-{$author->ID}.php";
+       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 );
@@ -92,22 +147,27 @@ function get_author_template() {
 /**
  * Retrieve path of category template in current or parent template.
  *
- * Works by first retrieving the current slug for example 'category-default.php' and then
- * trying category ID, for example 'category-1.php' and will finally fallback to category.php
+ * Works by first retrieving the current slug, for example 'category-default.php', and then
+ * 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();
 
-       $templates[] = "category-{$category->slug}.php";
-       $templates[] = "category-{$category->term_id}.php";
+       if ( ! empty( $category->slug ) ) {
+               $templates[] = "category-{$category->slug}.php";
+               $templates[] = "category-{$category->term_id}.php";
+       }
        $templates[] = 'category.php';
 
        return get_query_template( 'category', $templates );
@@ -116,22 +176,27 @@ function get_category_template() {
 /**
  * Retrieve path of tag template in current or parent template.
  *
- * Works by first retrieving the current tag name, for example 'tag-wordpress.php' and then
- * trying tag ID, for example 'tag-1.php' and will finally fallback to tag.php
+ * Works by first retrieving the current tag name, for example 'tag-wordpress.php', and then
+ * 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();
 
-       $templates[] = "tag-{$tag->slug}.php";
-       $templates[] = "tag-{$tag->term_id}.php";
+       if ( ! empty( $tag->slug ) ) {
+               $templates[] = "tag-{$tag->slug}.php";
+               $templates[] = "tag-{$tag->term_id}.php";
+       }
        $templates[] = 'tag.php';
 
        return get_query_template( 'tag', $templates );
@@ -149,19 +214,24 @@ function get_tag_template() {
  * 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();
-       $taxonomy = $term->taxonomy;
 
        $templates = array();
 
-       $templates[] = "taxonomy-$taxonomy-{$term->slug}.php";
-       $templates[] = "taxonomy-$taxonomy.php";
+       if ( ! empty( $term->slug ) ) {
+               $taxonomy = $term->taxonomy;
+               $templates[] = "taxonomy-$taxonomy-{$term->slug}.php";
+               $templates[] = "taxonomy-$taxonomy.php";
+       }
        $templates[] = 'taxonomy.php';
 
        return get_query_template( 'taxonomy', $templates );
@@ -170,9 +240,13 @@ function get_taxonomy_template() {
 /**
  * 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');
@@ -181,14 +255,16 @@ function get_date_template() {
 /**
  * Retrieve path of home template in current or parent template.
  *
- * This is the template used for the page containing the blog posts
- *
+ * 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' );
@@ -199,12 +275,14 @@ function get_home_template() {
 /**
  * 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');
@@ -215,13 +293,17 @@ function get_front_page_template() {
 /**
  * Retrieve path of page template in current or parent template.
  *
- * Will first look for the specifically assigned page template
- * The will search for 'page-{slug}.php' followed by 'page-id.php'
- * and finally 'page.php'
+ * Will first look for the specifically assigned page template.
+ * 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();
@@ -231,7 +313,8 @@ function get_page_template() {
        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();
@@ -249,9 +332,13 @@ function get_page_template() {
 /**
  * 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');
@@ -260,9 +347,13 @@ function get_paged_template() {
 /**
  * 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');
@@ -271,16 +362,21 @@ function get_search_template() {
 /**
  * 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();
 
-       $templates[] = "single-{$object->post_type}.php";
+       if ( ! empty( $object->post_type ) )
+               $templates[] = "single-{$object->post_type}.php";
        $templates[] = "single.php";
 
        return get_query_template( 'single', $templates );
@@ -297,21 +393,33 @@ function get_single_template() {
  * 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;
-       $type = explode('/', $posts[0]->post_mime_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;
-       else
-               return get_query_template('attachment');
+
+       if ( ! empty( $posts ) && isset( $posts[0]->post_mime_type ) ) {
+               $type = explode( '/', $posts[0]->post_mime_type );
+
+               if ( ! empty( $type ) ) {
+                       if ( $template = get_query_template( $type[0] ) )
+                               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;
+                       }
+               }
+       }
+
+       return get_query_template( 'attachment' );
 }
 
 /**
@@ -320,10 +428,13 @@ function get_attachment_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' ) );
@@ -356,7 +467,7 @@ function locate_template($template_names, $load = false, $require_once = true )
                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;
                }