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.


git-svn-id: https://develop.svn.wordpress.org/trunk@33273 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-07-14 22:11:52 +00:00
parent 7b91a81c4a
commit b55154c579

View File

@ -31,13 +31,13 @@ function get_query_template( $type, $templates = array() ) {
/**
* 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 );
}