enmi-conf.org: comparison wp/wp-includes/template.php

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 /**
 * Retrieve path to a template
 *
 * Used to quickly retrieve the path of a template without including the file
 * extension. It will also check the parent theme, if the file exists, with
-* the use of {@link locate_template()}. Allows for more generic template location
+* the use of locate_template(). Allows for more generic template location
 * without the use of the other get_*_template() functions.
 *
 * @since 1.5.0
 *
-* @param string $type Filename without extension.
+* @param string $type      Filename without extension.
-* @param array $templates An optional list of template candidates
+* @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 );
 	if ( empty( $templates ) )
 		$templates = array("{$type}.php");
+	/**
+	 * Filters the list of template filenames that are searched for when retrieving a template to use.
+	 *
+	 * The last element in the array should always be the fallback template for this query type.
+	 *
+	 * Possible values for `$type` include: 'index', '404', 'archive', 'author', 'category', 'tag', 'taxonomy', 'date',
+	 * 'embed', 'home', 'frontpage', 'page', 'paged', 'search', 'single', 'singular', and 'attachment'.
+	 *
+	 * @since 4.7.0
+	 *
+	 * @param array $templates A list of template candidates, in descending order of priority.
+	 */
+	$templates = apply_filters( "{$type}_template_hierarchy", $templates );
 	$template = locate_template( $templates );
 	/**
-	 * Filter the path of the queried template by type.
+	 * Filters the path of the queried template by type.
 	 *
-	 * The dynamic portion of the hook name, `$type`, refers to the filename
+	 * The dynamic portion of the hook name, `$type`, refers to the filename -- minus the file
-	 * -- minus the extension -- of the file to load. This hook also applies
+	 * extension and any non-alphanumeric characters delimiting words -- of the file to load.
-	 * to various types of files loaded as part of the Template Hierarchy.
+	 * 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',
+	 * 'embed', 'home', 'frontpage', 'page', 'paged', 'search', 'single', 'singular', and 'attachment'.
 	 *
 	 * @since 1.5.0
-	 *
+	 * @since 4.8.0 The `$type` and `$templates` parameters were added.
-	 * @param string $template Path to the template. See {@see locate_template()}.
+	 *
+	 * @param string $template  Path to the template. See locate_template().
+	 * @param string $type      Filename without extension.
+	 * @param array  $templates A list of template candidates, in descending order of priority.
 	 */
-	return apply_filters( "{$type}_template", $template );
+	return apply_filters( "{$type}_template", $template, $type, $templates );
 }
 /**
 * Retrieve path of index template in current or parent template.
 *
-* The template path is filterable via the 'index_template' hook.
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'index'.
 *
 * @since 3.0.0
 *
 * @see get_query_template()
 *
 }
 /**
 * Retrieve path of 404 template in current or parent template.
 *
-* The template path is filterable via the '404_template' hook.
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is '404'.
 *
 * @since 1.5.0
 *
 * @see get_query_template()
 *
 }
 /**
 * Retrieve path of archive template in current or parent template.
 *
-* The template path is filterable via the 'archive_template' hook.
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'archive'.
 *
 * @since 1.5.0
 *
 * @see get_query_template()
 *
 }
 /**
 * Retrieve path of post type archive template in current or parent template.
 *
-* The template path is filterable via the 'archive_template' hook.
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'archive'.
 *
 * @since 3.7.0
 *
 * @see get_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 )
+	if ( ! ( $obj instanceof WP_Post_Type ) || ! $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.
+* The hierarchy for this template looks like:
+*
+* 1. author-{nicename}.php
+* 2. author-{id}.php
+* 3. author.php
+*
+* An example of this is:
+*
+* 1. author-john.php
+* 2. author-1.php
+* 3. author.php
+*
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'author'.
 *
 * @since 1.5.0
 *
 * @see get_query_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
+* The hierarchy for this template looks like:
-* trying category ID, for example 'category-1.php', and will finally fall back to category.php
+*
-* template, if those files don't exist.
+* 1. category-{slug}.php
-*
+* 2. category-{id}.php
-* The template path is filterable via the 'category_template' hook.
+* 3. category.php
 *
-* @since 1.5.0
+* An example of this is:
+*
+* 1. category-news.php
+* 2. category-2.php
+* 3. category.php
+*
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'category'.
+*
+* @since 1.5.0
+* @since 4.7.0 The decoded form of `category-{slug}.php` was added to the top of the
+*              template hierarchy when the category slug contains multibyte characters.
 *
 * @see get_query_template()
 *
 * @return string Full path to category template file.
 */
 	$category = get_queried_object();
 	$templates = array();
 	if ( ! empty( $category->slug ) ) {
+		$slug_decoded = urldecode( $category->slug );
+		if ( $slug_decoded !== $category->slug ) {
+			$templates[] = "category-{$slug_decoded}.php";
+		}
 		$templates[] = "category-{$category->slug}.php";
 		$templates[] = "category-{$category->term_id}.php";
 	}
 	$templates[] = 'category.php';
 }
 /**
 * 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
+* The hierarchy for this template looks like:
-* trying tag ID, for example 'tag-1.php', and will finally fall back to tag.php
+*
-* template, if those files don't exist.
+* 1. tag-{slug}.php
-*
+* 2. tag-{id}.php
-* The template path is filterable via the 'tag_template' hook.
+* 3. tag.php
+*
+* An example of this is:
+*
+* 1. tag-wordpress.php
+* 2. tag-3.php
+* 3. tag.php
+*
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'tag'.
 *
 * @since 2.3.0
+* @since 4.7.0 The decoded form of `tag-{slug}.php` was added to the top of the
+*              template hierarchy when the tag slug contains multibyte characters.
 *
 * @see get_query_template()
 *
 * @return string Full path to tag template file.
 */
 	$tag = get_queried_object();
 	$templates = array();
 	if ( ! empty( $tag->slug ) ) {
+		$slug_decoded = urldecode( $tag->slug );
+		if ( $slug_decoded !== $tag->slug ) {
+			$templates[] = "tag-{$slug_decoded}.php";
+		}
 		$templates[] = "tag-{$tag->slug}.php";
 		$templates[] = "tag-{$tag->term_id}.php";
 	}
 	$templates[] = 'tag.php';
 	return get_query_template( 'tag', $templates );
 }
 /**
-* Retrieve path of taxonomy template in current or parent template.
+* Retrieve path of custom taxonomy term template in current or parent template.
 *
-* Retrieves the taxonomy and term, if term is available. The template is
+* The hierarchy for this template looks like:
-* prepended with 'taxonomy-' and followed by both the taxonomy string and
+*
-* the taxonomy string followed by a dash and then followed by the term.
+* 1. taxonomy-{taxonomy_slug}-{term_slug}.php
-*
+* 2. taxonomy-{taxonomy_slug}.php
-* The taxonomy and term template is checked and used first, if it exists.
+* 3. taxonomy.php
-* Second, just the taxonomy template is checked, and then finally, taxonomy.php
+*
-* template is used. If none of the files exist, then it will fall back on to
+* An example of this is:
-* index.php.
+*
-*
+* 1. taxonomy-location-texas.php
-* The template path is filterable via the 'taxonomy_template' hook.
+* 2. taxonomy-location.php
+* 3. taxonomy.php
+*
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'taxonomy'.
 *
 * @since 2.5.0
-*
+* @since 4.7.0 The decoded form of `taxonomy-{taxonomy_slug}-{term_slug}.php` was added to the top of the
-* @see get_query_template()
+*              template hierarchy when the term slug contains multibyte characters.
 *
-* @return string Full path to taxonomy template file.
+* @see get_query_template()
+*
+* @return string Full path to custom taxonomy term template file.
 */
 function get_taxonomy_template() {
 	$term = get_queried_object();
 	$templates = array();
 	if ( ! empty( $term->slug ) ) {
 		$taxonomy = $term->taxonomy;
+		$slug_decoded = urldecode( $term->slug );
+		if ( $slug_decoded !== $term->slug ) {
+			$templates[] = "taxonomy-$taxonomy-{$slug_decoded}.php";
+		}
 		$templates[] = "taxonomy-$taxonomy-{$term->slug}.php";
 		$templates[] = "taxonomy-$taxonomy.php";
 	}
 	$templates[] = 'taxonomy.php';
 }
 /**
 * Retrieve path of date template in current or parent template.
 *
-* The template path is filterable via the 'date_template' hook.
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'date'.
 *
 * @since 1.5.0
 *
 * @see get_query_template()
 *
 }
 /**
 * Retrieve path of home template in current or parent template.
 *
-* This is the template used for the page containing the blog posts.
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
-* Attempts to locate 'home.php' first before falling back to 'index.php'.
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'home'.
-*
-* The template path is filterable via the 'home_template' hook.
 *
 * @since 1.5.0
 *
 * @see get_query_template()
 *
 	return get_query_template( 'home', $templates );
 }
 /**
-* Retrieve path of front-page template in current or parent template.
+* Retrieve path of front page template in current or parent template.
 *
-* Looks for 'front-page.php'. The template path is filterable via the
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
-* 'front_page_template' hook.
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'frontpage'.
 *
 * @since 3.0.0
 *
 * @see get_query_template()
 *
 }
 /**
 * Retrieve path of page template in current or parent template.
 *
-* Will first look for the specifically assigned page template.
+* The hierarchy for this template looks like:
-* Then will search for 'page-{slug}.php', followed by 'page-{id}.php',
+*
-* and finally 'page.php'.
+* 1. {Page Template}.php
-*
+* 2. page-{page_name}.php
-* The template path is filterable via the 'page_template' hook.
+* 3. page-{id}.php
-*
+* 4. page.php
-* @since 1.5.0
+*
+* An example of this is:
+*
+* 1. page-templates/full-width.php
+* 2. page-about.php
+* 3. page-4.php
+* 4. page.php
+*
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'page'.
+*
+* @since 1.5.0
+* @since 4.7.0 The decoded form of `page-{page_name}.php` was added to the top of the
+*              template hierarchy when the page name contains multibyte characters.
 *
 * @see get_query_template()
 *
 * @return string Full path to page template file.
 */
 	}
 	$templates = array();
 	if ( $template && 0 === validate_file( $template ) )
 		$templates[] = $template;
-	if ( $pagename )
+	if ( $pagename ) {
-		$templates[] = "page-$pagename.php";
+		$pagename_decoded = urldecode( $pagename );
+		if ( $pagename_decoded !== $pagename ) {
+			$templates[] = "page-{$pagename_decoded}.php";
+		}
+		$templates[] = "page-{$pagename}.php";
+	}
 	if ( $id )
-		$templates[] = "page-$id.php";
+		$templates[] = "page-{$id}.php";
 	$templates[] = 'page.php';
 	return get_query_template( 'page', $templates );
 }
 /**
-* Retrieve path of paged template in current or parent template.
-*
-* The template path is filterable via the 'paged_template' hook.
-*
-* @since 1.5.0
-*
-* @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.
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'search'.
 *
 * @since 1.5.0
 *
 * @see get_query_template()
 *
 function get_search_template() {
 	return get_query_template('search');
 }
 /**
-* Retrieve path of single template in current or parent template.
+* Retrieve path of single template in current or parent template. Applies to single Posts,
-*
+* single Attachments, and single custom post types.
-* The template path is filterable via the 'single_template' hook.
+*
-*
+* The hierarchy for this template looks like:
-* @since 1.5.0
+*
+* 1. {Post Type Template}.php
+* 2. single-{post_type}-{post_name}.php
+* 3. single-{post_type}.php
+* 4. single.php
+*
+* An example of this is:
+*
+* 1. templates/full-width.php
+* 2. single-post-hello-world.php
+* 3. single-post.php
+* 4. single.php
+*
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'single'.
+*
+* @since 1.5.0
+* @since 4.4.0 `single-{post_type}-{post_name}.php` was added to the top of the template hierarchy.
+* @since 4.7.0 The decoded form of `single-{post_type}-{post_name}.php` was added to the top of the
+*              template hierarchy when the post name contains multibyte characters.
+* @since 4.7.0 {Post Type Template}.php was added to the top of the template hierarchy.
 *
 * @see get_query_template()
 *
 * @return string Full path to single template file.
 */
 function get_single_template() {
 	$object = get_queried_object();
 	$templates = array();
-	if ( ! empty( $object->post_type ) )
+	if ( ! empty( $object->post_type ) ) {
+		$template = get_page_template_slug( $object );
+		if ( $template && 0 === validate_file( $template ) ) {
+			$templates[] = $template;
+		}
+		$name_decoded = urldecode( $object->post_name );
+		if ( $name_decoded !== $object->post_name ) {
+			$templates[] = "single-{$object->post_type}-{$name_decoded}.php";
+		}
+		$templates[] = "single-{$object->post_type}-{$object->post_name}.php";
 		$templates[] = "single-{$object->post_type}.php";
+	}
 	$templates[] = "single.php";
 	return get_query_template( 'single', $templates );
 }
 /**
+* Retrieves an embed template path in the current or parent template.
+*
+* The hierarchy for this template looks like:
+*
+* 1. embed-{post_type}-{post_format}.php
+* 2. embed-{post_type}.php
+* 3. embed.php
+*
+* An example of this is:
+*
+* 1. embed-post-audio.php
+* 2. embed-post.php
+* 3. embed.php
+*
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'embed'.
+*
+* @since 4.5.0
+*
+* @see get_query_template()
+*
+* @return string Full path to embed template file.
+*/
+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";
+	}
+	$templates[] = "embed.php";
+	return get_query_template( 'embed', $templates );
+}
+/**
+* Retrieves the path of the singular template in current or parent template.
+*
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'singular'.
+*
+* @since 4.3.0
+*
+* @see get_query_template()
+*
+* @return string Full path to singular template file
+*/
+function get_singular_template() {
+	return get_query_template( 'singular' );
+}
+/**
 * 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 hierarchy for this template looks like:
-* 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
+* 1. {mime_type}-{sub_type}.php
-* 'attachment.php' is checked and returned.
+* 2. {sub_type}.php
-*
+* 3. {mime_type}.php
-* Some examples for the 'text/plain' mime type are 'text.php', 'plain.php', and
+* 4. attachment.php
-* finally 'text_plain.php'.
+*
-*
+* An example of this is:
-* The template path is filterable via the 'attachment_template' hook.
+*
+* 1. image-jpeg.php
+* 2. jpeg.php
+* 3. image.php
+* 4. attachment.php
+*
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'attachment'.
 *
 * @since 2.0.0
-*
+* @since 4.3.0 The order of the mime type logic was reversed so the hierarchy is more logical.
-* @see get_query_template()
+*
+* @see get_query_template()
+*
+* @global array $posts
 *
 * @return string Full path to attachment template file.
 */
 function get_attachment_template() {
-	global $posts;
+	$attachment = get_queried_object();
-	if ( ! empty( $posts ) && isset( $posts[0]->post_mime_type ) ) {
+	$templates = array();
-		$type = explode( '/', $posts[0]->post_mime_type );
+	if ( $attachment ) {
-		if ( ! empty( $type ) ) {
+		if ( false !== strpos( $attachment->post_mime_type, '/' ) ) {
-			if ( $template = get_query_template( $type[0] ) )
+			list( $type, $subtype ) = explode( '/', $attachment->post_mime_type );
-				return $template;
+		} else {
-			elseif ( ! empty( $type[1] ) ) {
+			list( $type, $subtype ) = array( $attachment->post_mime_type, '' );
-				if ( $template = get_query_template( $type[1] ) )
+		}
-					return $template;
-				elseif ( $template = get_query_template( "$type[0]_$type[1]" ) )
+		if ( ! empty( $subtype ) ) {
-					return $template;
+			$templates[] = "{$type}-{$subtype}.php";
-			}
+			$templates[] = "{$subtype}.php";
 		}
-	}
+		$templates[] = "{$type}.php";
+	}
-	return get_query_template( 'attachment' );
+	$templates[] = 'attachment.php';
-}
+	return get_query_template( 'attachment', $templates );
-/**
-* Retrieve path of comment popup 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 'comments_popup_template' hook.
-*
-* @since 1.5.0
-*
-* @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' ) );
-	// Backward compat code will be removed in a future release
-	if ('' == $template)
-		$template = ABSPATH . WPINC . '/theme-compat/comments-popup.php';
-	return $template;
 }
 /**
 * Retrieve the name of the highest priority template file that exists.
 *
-* Searches in the STYLESHEETPATH before TEMPLATEPATH so that themes which
+* Searches in the STYLESHEETPATH before TEMPLATEPATH and wp-includes/theme-compat
-* inherit from a parent theme can just overload one file.
+* 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         $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         $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 ) {
 	$located = '';
 	foreach ( (array) $template_names as $template_name ) {
 			$located = STYLESHEETPATH . '/' . $template_name;
 			break;
 		} 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;
 		}
 	}
 	if ( $load && '' != $located )
 		load_template( $located, $require_once );
 * environment is available from within the function. The query variables are
 * also available.
 *
 * @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 );
-}
+	}
+}

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9