Changeset 40964

Timestamp:

06/29/2017 04:04:45 PM (7 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/template.php (modified) (15 diffs)

trunk/src/wp-includes/template.php

@@ -66 +66 @@
  * 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
@@ -82 +82 @@
  * 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
@@ -161 +161 @@
  * 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
@@ -199 +199 @@
  * 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
@@ -245 +245 @@
  * 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
@@ -291 +291 @@
  * 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
@@ -326 +326 @@
  * 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
@@ -342 +342 @@
  * 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
@@ -360 +360 @@
  * 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
@@ -392 +392 @@
  * 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
@@ -435 +435 @@
  * 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
@@ -466 +466 @@
  * 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
@@ -519 +519 @@
  * 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
@@ -549 +549 @@
  * 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
@@ -579 +579 @@
  * 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