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

Props jonlynch.
Fixes #25488.


git-svn-id: https://develop.svn.wordpress.org/trunk@25702 602fd350-edb4-49c9-b593-d223f7449a82

src/wp-includes/template-loader.php

@@ -4,15 +4,34 @@
  * @package WordPress
  */
 if ( defined('WP_USE_THEMES') && WP_USE_THEMES )
-	do_action('template_redirect');
+	/**
+	 * Fires before determining which template to load.
+	 *
+	 * @since 1.5.2
+	 */
+	do_action( 'template_redirect' );
 
-// Halt template load for HEAD requests. Performance bump. See #14348
+/**
+ * Filter whether to allow 'HEAD' requests to generate content.
+ *
+ * Provides a significant performance bump by exiting before the page
+ * content loads for 'HEAD' requests. See #14348.
+ *
+ * @since 3.5.0
+ *
+ * @param bool $exit Whether to exit without generating any content for 'HEAD' requests. Default true.
+ */
 if ( 'HEAD' === $_SERVER['REQUEST_METHOD'] && apply_filters( 'exit_on_http_head', true ) )
 	exit();
 
 // Process feeds and trackbacks even if not using themes.
 if ( is_robots() ) :
-	do_action('do_robots');
+	/**
+	 * Fired when the template loader determines a robots.txt request.
+	 *
+	 * @since 2.1.0
+	 */
+	do_action( 'do_robots' );
 	return;
 elseif ( is_feed() ) :
 	do_feed();
@@ -44,6 +63,13 @@ if ( defined('WP_USE_THEMES') && WP_USE_THEMES ) :
 	else :
 		$template = get_index_template();
 	endif;
+	/**
+	 * Filter the path of the current template before including it.
+	 *
+	 * @since 3.0.0
+	 *
+	 * @param string $template The path of the template to include.
+	 */
 	if ( $template = apply_filters( 'template_include', $template ) )
 		include( $template );
 	return;