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_type = get_query_var( '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();
85 $templates[] = "author-{$author->user_nicename}.php";
86 $templates[] = "author-{$author->ID}.php";
87 $templates[] = 'author.php';
89 return get_query_template( 'author', $templates );
93 * Retrieve path of category template in current or parent template.
95 * Works by first retrieving the current slug for example 'category-default.php' and then
96 * trying category ID, for example 'category-1.php' and will finally fallback to category.php
97 * template, if those files don't exist.
100 * @uses apply_filters() Calls 'category_template' on file path of category template.
104 function get_category_template() {
105 $category = get_queried_object();
107 $templates = array();
109 $templates[] = "category-{$category->slug}.php";
110 $templates[] = "category-{$category->term_id}.php";
111 $templates[] = 'category.php';
113 return get_query_template( 'category', $templates );
117 * Retrieve path of tag template in current or parent template.
119 * Works by first retrieving the current tag name, for example 'tag-wordpress.php' and then
120 * trying tag ID, for example 'tag-1.php' and will finally fallback to tag.php
121 * template, if those files don't exist.
124 * @uses apply_filters() Calls 'tag_template' on file path of tag template.
128 function get_tag_template() {
129 $tag = get_queried_object();
131 $templates = array();
133 $templates[] = "tag-{$tag->slug}.php";
134 $templates[] = "tag-{$tag->term_id}.php";
135 $templates[] = 'tag.php';
137 return get_query_template( 'tag', $templates );
141 * Retrieve path of taxonomy template in current or parent template.
143 * Retrieves the taxonomy and term, if term is available. The template is
144 * prepended with 'taxonomy-' and followed by both the taxonomy string and
145 * the taxonomy string followed by a dash and then followed by the term.
147 * The taxonomy and term template is checked and used first, if it exists.
148 * Second, just the taxonomy template is checked, and then finally, taxonomy.php
149 * template is used. If none of the files exist, then it will fall back on to
153 * @uses apply_filters() Calls 'taxonomy_template' filter on found path.
157 function get_taxonomy_template() {
158 $term = get_queried_object();
159 $taxonomy = $term->taxonomy;
161 $templates = array();
163 $templates[] = "taxonomy-$taxonomy-{$term->slug}.php";
164 $templates[] = "taxonomy-$taxonomy.php";
165 $templates[] = 'taxonomy.php';
167 return get_query_template( 'taxonomy', $templates );
171 * Retrieve path of date template in current or parent template.
177 function get_date_template() {
178 return get_query_template('date');
182 * Retrieve path of home template in current or parent template.
184 * This is the template used for the page containing the blog posts
186 * Attempts to locate 'home.php' first before falling back to 'index.php'.
189 * @uses apply_filters() Calls 'home_template' on file path of home template.
193 function get_home_template() {
194 $templates = array( 'home.php', 'index.php' );
196 return get_query_template( 'home', $templates );
200 * Retrieve path of front-page template in current or parent template.
202 * Looks for 'front-page.php'.
205 * @uses apply_filters() Calls 'front_page_template' on file path of template.
209 function get_front_page_template() {
210 $templates = array('front-page.php');
212 return get_query_template( 'front_page', $templates );
216 * Retrieve path of page template in current or parent template.
218 * Will first look for the specifically assigned page template
219 * The will search for 'page-{slug}.php' followed by 'page-id.php'
220 * and finally 'page.php'
226 function get_page_template() {
227 $id = get_queried_object_id();
228 $template = get_page_template_slug();
229 $pagename = get_query_var('pagename');
231 if ( ! $pagename && $id ) {
232 // If a static page is set as the front page, $pagename will not be set. Retrieve it from the queried object
233 $post = get_queried_object();
234 $pagename = $post->post_name;
237 $templates = array();
238 if ( $template && 0 === validate_file( $template ) )
239 $templates[] = $template;
241 $templates[] = "page-$pagename.php";
243 $templates[] = "page-$id.php";
244 $templates[] = 'page.php';
246 return get_query_template( 'page', $templates );
250 * Retrieve path of paged template in current or parent template.
256 function get_paged_template() {
257 return get_query_template('paged');
261 * Retrieve path of search template in current or parent template.
267 function get_search_template() {
268 return get_query_template('search');
272 * Retrieve path of single template in current or parent template.
278 function get_single_template() {
279 $object = get_queried_object();
281 $templates = array();
283 $templates[] = "single-{$object->post_type}.php";
284 $templates[] = "single.php";
286 return get_query_template( 'single', $templates );
290 * Retrieve path of attachment template in current or parent template.
292 * The attachment path first checks if the first part of the mime type exists.
293 * The second check is for the second part of the mime type. The last check is
294 * for both types separated by an underscore. If neither are found then the file
295 * 'attachment.php' is checked and returned.
297 * Some examples for the 'text/plain' mime type are 'text.php', 'plain.php', and
298 * finally 'text_plain.php'.
304 function get_attachment_template() {
306 $type = explode('/', $posts[0]->post_mime_type);
307 if ( $template = get_query_template($type[0]) )
309 elseif ( $template = get_query_template($type[1]) )
311 elseif ( $template = get_query_template("$type[0]_$type[1]") )
314 return get_query_template('attachment');
318 * Retrieve path of comment popup template in current or parent template.
320 * Checks for comment popup template in current template, if it exists or in the
324 * @uses apply_filters() Calls 'comments_popup_template' filter on path.
328 function get_comments_popup_template() {
329 $template = get_query_template( 'comments_popup', array( 'comments-popup.php' ) );
331 // Backward compat code will be removed in a future release
333 $template = ABSPATH . WPINC . '/theme-compat/comments-popup.php';
339 * Retrieve the name of the highest priority template file that exists.
341 * Searches in the STYLESHEETPATH before TEMPLATEPATH so that themes which
342 * inherit from a parent theme can just overload one file.
346 * @param string|array $template_names Template file(s) to search for, in order.
347 * @param bool $load If true the template file will be loaded if it is found.
348 * @param bool $require_once Whether to require_once or require. Default true. Has no effect if $load is false.
349 * @return string The template filename if one is located.
351 function locate_template($template_names, $load = false, $require_once = true ) {
353 foreach ( (array) $template_names as $template_name ) {
354 if ( !$template_name )
356 if ( file_exists(STYLESHEETPATH . '/' . $template_name)) {
357 $located = STYLESHEETPATH . '/' . $template_name;
359 } else if ( file_exists(TEMPLATEPATH . '/' . $template_name) ) {
360 $located = TEMPLATEPATH . '/' . $template_name;
365 if ( $load && '' != $located )
366 load_template( $located, $require_once );
372 * Require the template file with WordPress environment.
374 * The globals are set up for the template file to ensure that the WordPress
375 * environment is available from within the function. The query variables are
380 * @param string $_template_file Path to template file.
381 * @param bool $require_once Whether to require_once or require. Default true.
383 function load_template( $_template_file, $require_once = true ) {
384 global $posts, $post, $wp_did_header, $wp_query, $wp_rewrite, $wpdb, $wp_version, $wp, $id, $comment, $user_ID;
386 if ( is_array( $wp_query->query_vars ) )
387 extract( $wp_query->query_vars, EXTR_SKIP );
390 require_once( $_template_file );
392 require( $_template_file );