Themes: Update filter names in the inline documentation for the `get_*_template()` functions.

See #14310, #37770


git-svn-id: https://develop.svn.wordpress.org/trunk@38418 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2016-08-28 16:14:53 +00:00
parent 58956ecf2d
commit 6ab9dc2dba
1 changed files with 37 additions and 37 deletions

View File

@ -62,8 +62,8 @@ function get_query_template( $type, $templates = array() ) {
/** /**
* Retrieve path of index template in current or parent template. * Retrieve path of index template in current or parent template.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'index_template_hierarchy'} hook.
* e.g. 'index_template'. * The template path is filterable via the {@see 'index_template'} hook.
* *
* @since 3.0.0 * @since 3.0.0
* *
@ -78,8 +78,8 @@ function get_index_template() {
/** /**
* Retrieve path of 404 template in current or parent template. * Retrieve path of 404 template in current or parent template.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see '404_template_hierarchy'} hook.
* e.g. '404_template'. * The template path is filterable via the {@see '404_template'} hook.
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -94,8 +94,8 @@ function get_404_template() {
/** /**
* Retrieve path of archive template in current or parent template. * Retrieve path of archive template in current or parent template.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'archive_template_hierarchy'} hook.
* e.g. 'archive_template'. * The template path is filterable via the {@see 'archive_template'} hook.
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -120,8 +120,8 @@ function get_archive_template() {
/** /**
* Retrieve path of post type archive template in current or parent template. * Retrieve path of post type archive template in current or parent template.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'archive_template_hierarchy'} hook.
* e.g. 'archive_template'. * The template path is filterable via the {@see 'archive_template'} hook.
* *
* @since 3.7.0 * @since 3.7.0
* *
@ -144,8 +144,8 @@ function get_post_type_archive_template() {
/** /**
* Retrieve path of author template in current or parent template. * Retrieve path of author template in current or parent template.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'author_template_hierarchy'} hook.
* e.g. 'author_template'. * The template path is filterable via the {@see 'author_template'} hook.
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -174,8 +174,8 @@ function get_author_template() {
* and then trying category ID, for example 'category-1.php', and will finally fall * 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. * back to category.php template, if those files don't exist.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'category_template_hierarchy'} hook.
* e.g. 'category_template'. * The template path is filterable via the {@see 'category_template'} hook.
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -204,8 +204,8 @@ function get_category_template() {
* and then trying tag ID, for example 'tag-1.php', and will finally fall back to * 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. * tag.php template, if those files don't exist.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'tag_template_hierarchy'} hook.
* e.g. 'tag_template'. * The template path is filterable via the {@see 'tag_template'} hook.
* *
* @since 2.3.0 * @since 2.3.0
* *
@ -239,8 +239,8 @@ function get_tag_template() {
* template is used. If none of the files exist, then it will fall back on to * template is used. If none of the files exist, then it will fall back on to
* index.php. * index.php.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'taxonomy_template_hierarchy'} hook.
* e.g. 'taxonomy_template'. * The template path is filterable via the {@see 'taxonomy_template'} hook.
* *
* @since 2.5.0 * @since 2.5.0
* *
@ -266,8 +266,8 @@ function get_taxonomy_template() {
/** /**
* Retrieve path of date template in current or parent template. * Retrieve path of date template in current or parent template.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'date_template_hierarchy'} hook.
* e.g. 'date_template'. * The template path is filterable via the {@see 'date_template'} hook.
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -285,8 +285,8 @@ function get_date_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'. * Attempts to locate 'home.php' first before falling back to 'index.php'.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'home_template_hierarchy'} hook.
* e.g. 'home_template'. * The template path is filterable via the {@see 'home_template'} hook.
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -301,10 +301,10 @@ function get_home_template() {
} }
/** /**
* 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 is filterable via the {@see 'frontpage_template_hierarchy'} hook.
* dynamic {@see '$type_template'} hook, e.g. 'frontpage_template'. * The template path is filterable via the {@see 'frontpage_template'} hook.
* *
* @since 3.0.0 * @since 3.0.0
* *
@ -325,8 +325,8 @@ function get_front_page_template() {
* Then will search for 'page-{slug}.php', followed by 'page-{id}.php', * Then will search for 'page-{slug}.php', followed by 'page-{id}.php',
* and finally 'page.php'. * and finally 'page.php'.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'page_template_hierarchy'} hook.
* e.g. 'page_template'. * The template path is filterable via the {@see 'page_template'} hook.
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -361,8 +361,8 @@ function get_page_template() {
/** /**
* Retrieve path of paged template in current or parent template. * Retrieve path of paged template in current or parent template.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'paged_template_hierarchy'} hook.
* e.g. 'paged_template'. * The template path is filterable via the {@see 'paged_template'} hook.
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -377,8 +377,8 @@ function get_paged_template() {
/** /**
* Retrieve path of search template in current or parent template. * Retrieve path of search template in current or parent template.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'search_template_hierarchy'} hook.
* e.g. 'search_template'. * The template path is filterable via the {@see 'search_template'} hook.
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -393,8 +393,8 @@ function get_search_template() {
/** /**
* Retrieve path of single template in current or parent template. * Retrieve path of single template in current or parent template.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'single_template_hierarchy'} hook.
* e.g. 'single_template'. * The template path is filterable via the {@see 'single_template'} hook.
* *
* @since 1.5.0 * @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.4.0 `single-{post_type}-{post_name}.php` was added to the top of the template hierarchy.
@ -423,8 +423,8 @@ function get_single_template() {
* *
* By default the WordPress-template is returned. * By default the WordPress-template is returned.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'embed_template_hierarchy'} hook.
* e.g. 'embed_template'. * The template path is filterable via the {@see 'embed_template'} hook.
* *
* @since 4.5.0 * @since 4.5.0
* *
@ -453,8 +453,8 @@ function get_embed_template() {
/** /**
* Retrieves the path of the singular template in current or parent template. * Retrieves the path of the singular template in current or parent template.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'singular_template_hierarchy'} hook.
* e.g. 'singular_template'. * The template path is filterable via the {@see 'singular_template'} hook.
* *
* @since 4.3.0 * @since 4.3.0
* *
@ -477,8 +477,8 @@ function get_singular_template() {
* Some examples for the 'text/plain' mime type are 'text.php', 'plain.php', and * Some examples for the 'text/plain' mime type are 'text.php', 'plain.php', and
* finally 'text-plain.php'. * finally 'text-plain.php'.
* *
* The template path is filterable via the dynamic {@see '$type_template'} hook, * The template hierarchy is filterable via the {@see 'attachment_template_hierarchy'} hook.
* e.g. 'attachment_template'. * The template path is filterable via the {@see 'attachment_template'} hook.
* *
* @since 2.0.0 * @since 2.0.0
* *