Changeset 25703

Timestamp:

10/06/2013 07:00:05 PM (13 years ago)

Author:

DrewAPicture

Message:

Inline documentation for a hooks in wp-includes/template.php.

Props jonlynch for the initial patch.
Fixes #25487.

File:

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

trunk/src/wp-includes/template.php

@@ -27 +27 @@
                 $templates = array("{$type}.php");
 
-        return apply_filters( "{$type}_template", locate_template( $templates ) );
+        $template = locate_template( $templates );
+        /**
+         * 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.
+         *
+         * @since 1.5.2
+         *
+         * @param string $template Path to the template. @see locate_template()
+         */
+        return apply_filters( "{$type}_template", $template );
 }