From 1fb8cbe8de772e75c3d65a060c33fa0ce5116d3a Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Thu, 29 Jun 2017 16:05:41 +0000 Subject: [PATCH] Docs: Don't reference non-existent hooks inline in the DocBlock descriptions for the following template functions: * `get_index_template()` * `get_404_template()` * `get_author_template()` * `get_category_template()` * `get_tag_template()` * `get_taxonomy_template()` * `get_date_template()` * `get_home_template()` * `get_front_page_template()` * `get_page_template()` * `get_search_template()` * `get_single_template()` * `get_embed_template()` * `get_singular_template()` * `get_attachment_template()` As mentioned when these dynamic hook references were originally fixed in [33274], we can't link to non-existent hooks inline because the Code Reference auto-linker won't pick up on the dynamic-ness of the hook, it'll just try to link to a hook reference that doesn't exist. In these cases, we need to be generic and provide context for the value of `$type`. See [38418] for where the original fix was reversed. See this changeset for reversing the reversal. Props donutz, milana_cap. Fixes #41198. Built from https://develop.svn.wordpress.org/trunk@40964 git-svn-id: http://core.svn.wordpress.org/trunk@40814 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/template.php | 60 ++++++++++++++++++++-------------------- wp-includes/version.php | 2 +- 2 files changed, 31 insertions(+), 31 deletions(-) diff --git a/wp-includes/template.php b/wp-includes/template.php index 7a4181b093..4205ce9fcd 100644 --- a/wp-includes/template.php +++ b/wp-includes/template.php @@ -65,8 +65,8 @@ function get_query_template( $type, $templates = array() ) { /** * Retrieve path of index template in current or parent template. * - * The template hierarchy is filterable via the {@see 'index_template_hierarchy'} hook. - * The template path is filterable via the {@see '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 * @@ -81,8 +81,8 @@ function get_index_template() { /** * Retrieve path of 404 template in current or parent template. * - * The template hierarchy is filterable via the {@see '404_template_hierarchy'} hook. - * The template path is filterable via the {@see '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 * @@ -160,8 +160,8 @@ function get_post_type_archive_template() { * 2. author-1.php * 3. author.php * - * The template hierarchy is filterable via the {@see 'author_template_hierarchy'} hook. - * The template path is filterable via the {@see 'author_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 'author'. * * @since 1.5.0 * @@ -198,8 +198,8 @@ function get_author_template() { * 2. category-2.php * 3. category.php * - * The template hierarchy is filterable via the {@see 'category_template_hierarchy'} hook. - * The template path is filterable via the {@see 'category_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 'category'. * * @since 1.5.0 * @since 4.7.0 The decoded form of `category-{slug}.php` was added to the top of the @@ -244,8 +244,8 @@ function get_category_template() { * 2. tag-3.php * 3. tag.php * - * The template hierarchy is filterable via the {@see 'tag_template_hierarchy'} hook. - * The template path is filterable via the {@see 'tag_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 'tag'. * * @since 2.3.0 * @since 4.7.0 The decoded form of `tag-{slug}.php` was added to the top of the @@ -290,8 +290,8 @@ function get_tag_template() { * 2. taxonomy-location.php * 3. taxonomy.php * - * The template hierarchy is filterable via the {@see 'taxonomy_template_hierarchy'} hook. - * The template path is filterable via the {@see 'taxonomy_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 '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 @@ -325,8 +325,8 @@ function get_taxonomy_template() { /** * Retrieve path of date template in current or parent template. * - * The template hierarchy is filterable via the {@see 'date_template_hierarchy'} hook. - * The template path is filterable via the {@see '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 * @@ -341,8 +341,8 @@ function get_date_template() { /** * Retrieve path of home template in current or parent template. * - * The template hierarchy is filterable via the {@see 'home_template_hierarchy'} hook. - * The template path is filterable via the {@see 'home_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 'home'. * * @since 1.5.0 * @@ -359,8 +359,8 @@ function get_home_template() { /** * Retrieve path of front page template in current or parent template. * - * The template hierarchy is filterable via the {@see 'frontpage_template_hierarchy'} hook. - * The template path is filterable via the {@see 'frontpage_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 'frontpage'. * * @since 3.0.0 * @@ -391,8 +391,8 @@ function get_front_page_template() { * 3. page-4.php * 4. page.php * - * The template hierarchy is filterable via the {@see 'page_template_hierarchy'} hook. - * The template path is filterable via the {@see 'page_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 'page'. * * @since 1.5.0 * @since 4.7.0 The decoded form of `page-{page_name}.php` was added to the top of the @@ -434,8 +434,8 @@ function get_page_template() { /** * Retrieve path of search template in current or parent template. * - * The template hierarchy is filterable via the {@see 'search_template_hierarchy'} hook. - * The template path is filterable via the {@see '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 * @@ -465,8 +465,8 @@ function get_search_template() { * 3. single-post.php * 4. single.php * - * The template hierarchy is filterable via the {@see 'single_template_hierarchy'} hook. - * The template path is filterable via the {@see 'single_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 'single'. * * @since 1.5.0 * @since 4.4.0 `single-{post_type}-{post_name}.php` was added to the top of the template hierarchy. @@ -518,8 +518,8 @@ function get_single_template() { * 2. embed-post.php * 3. embed.php * - * The template hierarchy is filterable via the {@see 'embed_template_hierarchy'} hook. - * The template path is filterable via the {@see 'embed_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 'embed'. * * @since 4.5.0 * @@ -548,8 +548,8 @@ function get_embed_template() { /** * Retrieves the path of the singular template in current or parent template. * - * The template hierarchy is filterable via the {@see 'singular_template_hierarchy'} hook. - * The template path is filterable via the {@see 'singular_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 'singular'. * * @since 4.3.0 * @@ -578,8 +578,8 @@ function get_singular_template() { * 3. image.php * 4. attachment.php * - * The template hierarchy is filterable via the {@see 'attachment_template_hierarchy'} hook. - * The template path is filterable via the {@see 'attachment_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 'attachment'. * * @since 2.0.0 * @since 4.3.0 The order of the mime type logic was reversed so the hierarchy is more logical. diff --git a/wp-includes/version.php b/wp-includes/version.php index 3c0d82a4bb..5361953162 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.9-alpha-40963'; +$wp_version = '4.9-alpha-40964'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.