WordPress 4.5
[autoinstalls/wordpress.git] / wp-includes / template.php
index 99d004687b66155336d935c630ed5c66dbe5d3fd..b2e4e242284ef965365a42d891f403b5c93d8df3 100644 (file)
@@ -16,9 +16,9 @@
  *
  * @since 1.5.0
  *
- * @param string $type Filename without extension.
- * @param array $templates An optional list of template candidates
- * @return string Full path to file.
+ * @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 );
@@ -26,15 +26,36 @@ 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 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',
+        * 'home', 'front_page', 'page', 'paged', 'search', 'single', 'singular', and 'attachment'.
+        *
+        * @since 1.5.0
+        *
+        * @param string $template Path to the template. 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 dynamic {@see '$type_template'} hook,
+ * e.g. 'index_template'.
+ *
  * @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 +64,14 @@ function get_index_template() {
 /**
  * Retrieve path of 404 template in current or parent template.
  *
+ * The template path is filterable via the dynamic {@see '$type_template'} hook,
+ * e.g. '404_template'.
+ *
  * @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,9 +80,14 @@ function get_404_template() {
 /**
  * Retrieve path of archive template in current or parent template.
  *
+ * The template path is filterable via the dynamic {@see '$type_template'} hook,
+ * e.g. 'archive_template'.
+ *
  * @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' ) );
@@ -72,19 +103,48 @@ function get_archive_template() {
        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 dynamic {@see '$type_template'} hook,
+ * e.g. 'archive_template'.
+ *
+ * @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 dynamic {@see '$type_template'} hook,
+ * e.g. 'author_template'.
+ *
  * @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";
        }
@@ -96,21 +156,25 @@ 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
- * template, if those files don't exist.
+ * 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 dynamic {@see '$type_template'} hook,
+ * e.g. 'category_template'.
  *
  * @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";
        }
@@ -122,21 +186,25 @@ 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
- * template, if those files don't exist.
+ * 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 dynamic {@see '$type_template'} hook,
+ * e.g. 'tag_template'.
  *
  * @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";
        }
@@ -157,17 +225,21 @@ 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 dynamic {@see '$type_template'} hook,
+ * e.g. 'taxonomy_template'.
+ *
  * @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";
@@ -180,9 +252,14 @@ function get_taxonomy_template() {
 /**
  * Retrieve path of date template in current or parent template.
  *
+ * The template path is filterable via the dynamic {@see '$type_template'} hook,
+ * e.g. 'date_template'.
+ *
  * @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');
@@ -191,14 +268,17 @@ 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 dynamic {@see '$type_template'} hook,
+ * e.g. 'home_template'.
+ *
  * @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' );
@@ -209,12 +289,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
+ * dynamic {@see '$type_template'} hook, e.g. 'frontpage_template'.
  *
  * @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');
@@ -225,13 +307,18 @@ 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 dynamic {@see '$type_template'} hook,
+ * e.g. 'page_template'.
  *
  * @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();
@@ -241,7 +328,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();
@@ -259,9 +347,14 @@ function get_page_template() {
 /**
  * Retrieve path of paged template in current or parent template.
  *
+ * The template path is filterable via the dynamic {@see '$type_template'} hook,
+ * e.g. 'paged_template'.
+ *
  * @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');
@@ -270,9 +363,14 @@ function get_paged_template() {
 /**
  * Retrieve path of search template in current or parent template.
  *
+ * The template path is filterable via the dynamic {@see '$type_template'} hook,
+ * e.g. 'search_template'.
+ *
  * @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');
@@ -281,88 +379,135 @@ function get_search_template() {
 /**
  * Retrieve path of single template in current or parent template.
  *
+ * The template path is filterable via the dynamic {@see '$type_template'} hook,
+ * e.g. 'single_template'.
+ *
  * @since 1.5.0
+ * @since 4.4.0 `single-{post_type}-{post_name}.php` was added to the top of the template hierarchy.
+ *
+ * @see get_query_template()
  *
- * @return string
+ * @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}-{$object->post_name}.php";
                $templates[] = "single-{$object->post_type}.php";
+       }
+
        $templates[] = "single.php";
 
        return get_query_template( 'single', $templates );
 }
 
 /**
- * Retrieve path of attachment template in current or parent template.
+ * Retrieves an embed template path in the current or parent template.
  *
- * The attachment path first checks if the first part of the mime type exists.
- * The second check is for the second part of the mime type. The last check is
- * for both types separated by an underscore. If neither are found then the file
- * 'attachment.php' is checked and returned.
+ * By default the WordPress-template is returned.
  *
- * 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 dynamic {@see '$type_template'} hook,
+ * e.g. 'embed_template'.
  *
- * @since 2.0.0
+ * @since 4.5.0
  *
- * @return string
+ * @see get_query_template()
+ *
+ * @return string Full path to embed template file.
  */
-function get_attachment_template() {
-       global $posts;
-
-       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 ( $template = get_query_template( $type[1] ) )
-                               return $template;
-                       elseif ( $template = get_query_template( "$type[0]_$type[1]" ) )
-                               return $template;
+function get_embed_template() {
+       $object = get_queried_object();
+
+       $templates = array();
+
+       if ( ! empty( $object->post_type ) ) {
+               $post_format = get_post_format( $object );
+               if ( $post_format ) {
+                       $templates[] = "embed-{$object->post_type}-{$post_format}.php";
                }
+               $templates[] = "embed-{$object->post_type}.php";
        }
 
-       return get_query_template( 'attachment' );
+       $templates[] = "embed.php";
+
+       return get_query_template( 'embed', $templates );
 }
 
 /**
- * Retrieve path of comment popup template in current or parent template.
+ * Retrieves the path of the singular template in current or parent template.
  *
- * Checks for comment popup template in current template, if it exists or in the
- * parent template.
+ * The template path is filterable via the dynamic {@see '$type_template'} hook,
+ * e.g. 'singular_template'.
  *
- * @since 1.5.0
- * @uses apply_filters() Calls 'comments_popup_template' filter on path.
+ * @since 4.3.0
  *
- * @return string
+ * @see get_query_template()
+ *
+ * @return string Full path to singular template file
  */
-function get_comments_popup_template() {
-       $template = get_query_template( 'comments_popup', array( 'comments-popup.php' ) );
+function get_singular_template() {
+       return get_query_template( 'singular' );
+}
 
-       // Backward compat code will be removed in a future release
-       if ('' == $template)
-               $template = ABSPATH . WPINC . '/theme-compat/comments-popup.php';
+/**
+ * Retrieve path of attachment template in current or parent template.
+ *
+ * The attachment path first checks if the first part of the mime type exists.
+ * The second check is for the second part of the mime type. The last check is
+ * for both types separated by an underscore. If neither are found then the file
+ * 'attachment.php' is checked and returned.
+ *
+ * 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 dynamic {@see '$type_template'} hook,
+ * e.g. 'attachment_template'.
+ *
+ * @since 2.0.0
+ *
+ * @see get_query_template()
+ *
+ * @global array $posts
+ *
+ * @return string Full path to attachment template file.
+ */
+function get_attachment_template() {
+       $attachment = get_queried_object();
 
-       return $template;
+       $templates = array();
+
+       if ( $attachment ) {
+               if ( false !== strpos( $attachment->post_mime_type, '/' ) ) {
+                       list( $type, $subtype ) = explode( '/', $attachment->post_mime_type );
+               } else {
+                       list( $type, $subtype ) = array( $attachment->post_mime_type, '' );
+               }
+
+               if ( ! empty( $subtype ) ) {
+                       $templates[] = "{$type}-{$subtype}.php";
+                       $templates[] = "{$subtype}.php";
+               }
+               $templates[] = "{$type}.php";
+       }
+       $templates[] = 'attachment.php';
+
+       return get_query_template( 'attachment', $templates );
 }
 
 /**
  * Retrieve the name of the highest priority template file that exists.
  *
- * Searches in the STYLESHEETPATH before TEMPLATEPATH so that themes which
- * inherit from a parent theme can just overload one file.
+ * Searches in the STYLESHEETPATH before TEMPLATEPATH and wp-includes/theme-compat
+ * so that themes which inherit from a parent theme can just overload one file.
  *
  * @since 2.7.0
  *
  * @param string|array $template_names Template file(s) to search for, in order.
- * @param bool $load If true the template file will be loaded if it is found.
- * @param bool $require_once Whether to require_once or require. Default true. Has no effect if $load is false.
+ * @param bool         $load           If true the template file will be loaded if it is found.
+ * @param bool         $require_once   Whether to require_once or require. Default true. Has no effect if $load is false.
  * @return string The template filename if one is located.
  */
 function locate_template($template_names, $load = false, $require_once = true ) {
@@ -373,9 +518,12 @@ 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;
+               } elseif ( file_exists( ABSPATH . WPINC . '/theme-compat/' . $template_name ) ) {
+                       $located = ABSPATH . WPINC . '/theme-compat/' . $template_name;
+                       break;
                }
        }
 
@@ -394,18 +542,36 @@ function locate_template($template_names, $load = false, $require_once = true )
  *
  * @since 1.5.0
  *
+ * @global array      $posts
+ * @global WP_Post    $post
+ * @global bool       $wp_did_header
+ * @global WP_Query   $wp_query
+ * @global WP_Rewrite $wp_rewrite
+ * @global wpdb       $wpdb
+ * @global string     $wp_version
+ * @global WP         $wp
+ * @global int        $id
+ * @global WP_Comment $comment
+ * @global int        $user_ID
+ *
  * @param string $_template_file Path to template file.
- * @param bool $require_once Whether to require_once or require. Default true.
+ * @param bool   $require_once   Whether to require_once or require. Default true.
  */
 function load_template( $_template_file, $require_once = true ) {
        global $posts, $post, $wp_did_header, $wp_query, $wp_rewrite, $wpdb, $wp_version, $wp, $id, $comment, $user_ID;
 
-       if ( is_array( $wp_query->query_vars ) )
+       if ( is_array( $wp_query->query_vars ) ) {
                extract( $wp_query->query_vars, EXTR_SKIP );
+       }
 
-       if ( $require_once )
+       if ( isset( $s ) ) {
+               $s = esc_attr( $s );
+       }
+
+       if ( $require_once ) {
                require_once( $_template_file );
-       else
+       } else {
                require( $_template_file );
+       }
 }