Changeset 33273

Timestamp:

07/14/2015 10:11:52 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Clarify the hook docs for the {$type}_template hook to mention that non-alphanumeric characters delimiting words will also be removed from the passed $type parameter.

Also remove a now-unnecessary inline @see tag from the return description.

See #32246. See #32989.

File:

• trunk/src/wp-includes/template.php (modified) (1 diff)

trunk/src/wp-includes/template.php

@@ -32 +32 @@
      * Filter the path of the queried template by type.
      *
-     * The dynamic portion of the hook name, `$type`, refers to the filename
-     * -- minus the extension -- of the file to load. This hook also applies
-     * to various types of files loaded as part of the Template Hierarchy.
+     * The dynamic portion of the hook name, `$type`, refers to the filename -- minus the file
+     * extension and any non-alphanumeric characters delimiting words -- of the file to load.
+     * This hook also applies to various types of files loaded as part of the Template Hierarchy.
      *
      * @since 1.5.0
      *
-     * @param string $template Path to the template. See {@see locate_template()}.
+     * @param string $template Path to the template. See locate_template().
      */
     return apply_filters( "{$type}_template", $template );