3 * Template loading functions.
10 * Retrieve path to a template
12 * Used to quickly retrieve the path of a template without including the file
13 * extension. It will also check the parent theme, if the file exists, with
14 * the use of {@link locate_template()}. Allows for more generic template location
15 * without the use of the other get_*_template() functions.
19 * @param string $type Filename without extension.
20 * @param array $templates An optional list of template candidates
21 * @return string Full path to file.
23 function get_query_template( $type, $templates = array() ) {
24 $type = preg_replace( '|[^a-z0-9-]+|', '', $type );
26 if ( empty( $templates ) )
27 $templates = array("{$type}.php");
29 return apply_filters( "{$type}_template", locate_template( $templates ) );
33 * Retrieve path of index template in current or parent template.
39 function get_index_template() {
40 return get_query_template('index');
44 * Retrieve path of 404 template in current or parent template.
50 function get_404_template() {
51 return get_query_template('404');
55 * Retrieve path of archive template in current or parent template.
61 function get_archive_template() {
62 $post_types = get_query_var( 'post_type' );
66 foreach ( (array) $post_types as $post_type )
67 $templates[] = "archive-{$post_type}.php";
68 $templates[] = 'archive.php';
70 return get_query_template( 'archive', $templates );
74 * Retrieve path of author template in current or parent template.
80 function get_author_template() {
81 $author = get_queried_object();
86 $templates[] = "author-{$author->user_nicename}.php";
87 $templates[] = "author-{$author->ID}.php";
89 $templates[] = 'author.php';
91 return get_query_template( 'author', $templates );
95 * Retrieve path of category template in current or parent template.
97 * Works by first retrieving the current slug for example 'category-default.php' and then
98 * trying category ID, for example 'category-1.php' and will finally fallback to category.php
99 * template, if those files don't exist.
102 * @uses apply_filters() Calls 'category_template' on file path of category template.
106 function get_category_template() {
107 $category = get_queried_object();
109 $templates = array();
112 $templates[] = "category-{$category->slug}.php";
113 $templates[] = "category-{$category->term_id}.php";
115 $templates[] = 'category.php';
117 return get_query_template( 'category', $templates );
121 * Retrieve path of tag template in current or parent template.
123 * Works by first retrieving the current tag name, for example 'tag-wordpress.php' and then
124 * trying tag ID, for example 'tag-1.php' and will finally fallback to tag.php
125 * template, if those files don't exist.
128 * @uses apply_filters() Calls 'tag_template' on file path of tag template.
132 function get_tag_template() {
133 $tag = get_queried_object();
135 $templates = array();
138 $templates[] = "tag-{$tag->slug}.php";
139 $templates[] = "tag-{$tag->term_id}.php";
141 $templates[] = 'tag.php';
143 return get_query_template( 'tag', $templates );
147 * Retrieve path of taxonomy template in current or parent template.
149 * Retrieves the taxonomy and term, if term is available. The template is
150 * prepended with 'taxonomy-' and followed by both the taxonomy string and
151 * the taxonomy string followed by a dash and then followed by the term.
153 * The taxonomy and term template is checked and used first, if it exists.
154 * Second, just the taxonomy template is checked, and then finally, taxonomy.php
155 * template is used. If none of the files exist, then it will fall back on to
159 * @uses apply_filters() Calls 'taxonomy_template' filter on found path.
163 function get_taxonomy_template() {
164 $term = get_queried_object();
166 $templates = array();
169 $taxonomy = $term->taxonomy;
170 $templates[] = "taxonomy-$taxonomy-{$term->slug}.php";
171 $templates[] = "taxonomy-$taxonomy.php";
173 $templates[] = 'taxonomy.php';
175 return get_query_template( 'taxonomy', $templates );
179 * Retrieve path of date template in current or parent template.
185 function get_date_template() {
186 return get_query_template('date');
190 * Retrieve path of home template in current or parent template.
192 * This is the template used for the page containing the blog posts
194 * Attempts to locate 'home.php' first before falling back to 'index.php'.
197 * @uses apply_filters() Calls 'home_template' on file path of home template.
201 function get_home_template() {
202 $templates = array( 'home.php', 'index.php' );
204 return get_query_template( 'home', $templates );
208 * Retrieve path of front-page template in current or parent template.
210 * Looks for 'front-page.php'.
213 * @uses apply_filters() Calls 'front_page_template' on file path of template.
217 function get_front_page_template() {
218 $templates = array('front-page.php');
220 return get_query_template( 'front_page', $templates );
224 * Retrieve path of page template in current or parent template.
226 * Will first look for the specifically assigned page template
227 * The will search for 'page-{slug}.php' followed by 'page-id.php'
228 * and finally 'page.php'
234 function get_page_template() {
235 $id = get_queried_object_id();
236 $template = get_page_template_slug();
237 $pagename = get_query_var('pagename');
239 if ( ! $pagename && $id ) {
240 // If a static page is set as the front page, $pagename will not be set. Retrieve it from the queried object
241 $post = get_queried_object();
242 $pagename = $post->post_name;
245 $templates = array();
246 if ( $template && 0 === validate_file( $template ) )
247 $templates[] = $template;
249 $templates[] = "page-$pagename.php";
251 $templates[] = "page-$id.php";
252 $templates[] = 'page.php';
254 return get_query_template( 'page', $templates );
258 * Retrieve path of paged template in current or parent template.
264 function get_paged_template() {
265 return get_query_template('paged');
269 * Retrieve path of search template in current or parent template.
275 function get_search_template() {
276 return get_query_template('search');
280 * Retrieve path of single template in current or parent template.
286 function get_single_template() {
287 $object = get_queried_object();
289 $templates = array();
292 $templates[] = "single-{$object->post_type}.php";
293 $templates[] = "single.php";
295 return get_query_template( 'single', $templates );
299 * Retrieve path of attachment template in current or parent template.
301 * The attachment path first checks if the first part of the mime type exists.
302 * The second check is for the second part of the mime type. The last check is
303 * for both types separated by an underscore. If neither are found then the file
304 * 'attachment.php' is checked and returned.
306 * Some examples for the 'text/plain' mime type are 'text.php', 'plain.php', and
307 * finally 'text_plain.php'.
313 function get_attachment_template() {
316 if ( ! empty( $posts ) && isset( $posts[0]->post_mime_type ) ) {
317 $type = explode( '/', $posts[0]->post_mime_type );
319 if ( ! empty( $type ) ) {
320 if ( $template = get_query_template( $type[0] ) )
322 elseif ( $template = get_query_template( $type[1] ) )
324 elseif ( $template = get_query_template( "$type[0]_$type[1]" ) )
329 return get_query_template( 'attachment' );
333 * Retrieve path of comment popup template in current or parent template.
335 * Checks for comment popup template in current template, if it exists or in the
339 * @uses apply_filters() Calls 'comments_popup_template' filter on path.
343 function get_comments_popup_template() {
344 $template = get_query_template( 'comments_popup', array( 'comments-popup.php' ) );
346 // Backward compat code will be removed in a future release
348 $template = ABSPATH . WPINC . '/theme-compat/comments-popup.php';
354 * Retrieve the name of the highest priority template file that exists.
356 * Searches in the STYLESHEETPATH before TEMPLATEPATH so that themes which
357 * inherit from a parent theme can just overload one file.
361 * @param string|array $template_names Template file(s) to search for, in order.
362 * @param bool $load If true the template file will be loaded if it is found.
363 * @param bool $require_once Whether to require_once or require. Default true. Has no effect if $load is false.
364 * @return string The template filename if one is located.
366 function locate_template($template_names, $load = false, $require_once = true ) {
368 foreach ( (array) $template_names as $template_name ) {
369 if ( !$template_name )
371 if ( file_exists(STYLESHEETPATH . '/' . $template_name)) {
372 $located = STYLESHEETPATH . '/' . $template_name;
374 } else if ( file_exists(TEMPLATEPATH . '/' . $template_name) ) {
375 $located = TEMPLATEPATH . '/' . $template_name;
380 if ( $load && '' != $located )
381 load_template( $located, $require_once );
387 * Require the template file with WordPress environment.
389 * The globals are set up for the template file to ensure that the WordPress
390 * environment is available from within the function. The query variables are
395 * @param string $_template_file Path to template file.
396 * @param bool $require_once Whether to require_once or require. Default true.
398 function load_template( $_template_file, $require_once = true ) {
399 global $posts, $post, $wp_did_header, $wp_query, $wp_rewrite, $wpdb, $wp_version, $wp, $id, $comment, $user_ID;
401 if ( is_array( $wp_query->query_vars ) )
402 extract( $wp_query->query_vars, EXTR_SKIP );
405 require_once( $_template_file );
407 require( $_template_file );