From e5646d21e6b965f1a4cf0742ec5cac27ef10e967 Mon Sep 17 00:00:00 2001
From: Andrew Nacin <wp@andrewnacin.com>
Date: Thu, 5 Sep 2013 16:05:09 +0000
Subject: [PATCH] Inline documentation for hooks in wp-comments-post.php.

props rzen.
see #25229.

Built from https://develop.svn.wordpress.org/trunk@25249


git-svn-id: http://core.svn.wordpress.org/trunk@25217 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-comments-post.php | 79 ++++++++++++++++++++++++++++++++++++--------
 1 file changed, 66 insertions(+), 13 deletions(-)

diff --git a/wp-comments-post.php b/wp-comments-post.php
index 3be4e64c6f..65bae479f8 100644
--- a/wp-comments-post.php
+++ b/wp-comments-post.php
@@ -21,8 +21,14 @@ $comment_post_ID = isset($_POST['comment_post_ID']) ? (int) $_POST['comment_post
 
 $post = get_post($comment_post_ID);
 
-if ( empty($post->comment_status) ) {
-	do_action('comment_id_not_found', $comment_post_ID);
+if ( empty( $post->comment_status ) ) {
+	/**
+	 * Fires when a comment is attempted on a post that does not exist
+	 *
+	 * @since unknown
+	 * @param int $comment_post_ID Post ID
+	 */
+	do_action( 'comment_id_not_found', $comment_post_ID );
 	exit;
 }
 
@@ -31,20 +37,50 @@ $status = get_post_status($post);
 
 $status_obj = get_post_status_object($status);
 
-if ( !comments_open($comment_post_ID) ) {
-	do_action('comment_closed', $comment_post_ID);
+if ( ! comments_open( $comment_post_ID ) ) {
+	/**
+	 * Fires when a comment is attempted on a post that has comments closed
+	 *
+	 * @since unknown
+	 * @param int $comment_post_ID Post ID
+	 */
+	do_action( 'comment_closed', $comment_post_ID );
 	wp_die( __('Sorry, comments are closed for this item.') );
 } elseif ( 'trash' == $status ) {
-	do_action('comment_on_trash', $comment_post_ID);
+	/**
+	 * Fires when a comment is attempted on a trashed post
+	 *
+	 * @since 2.9.0
+	 * @param int $comment_post_ID Post ID
+	 */
+	do_action( 'comment_on_trash', $comment_post_ID );
 	exit;
-} elseif ( !$status_obj->public && !$status_obj->private ) {
-	do_action('comment_on_draft', $comment_post_ID);
+} elseif ( ! $status_obj->public && ! $status_obj->private ) {
+	/**
+	 * Fires when a comment is attempted on a post in draft mode
+	 *
+	 * @since unknown
+	 * @param int $comment_post_ID Post ID
+	 */
+	do_action( 'comment_on_draft', $comment_post_ID );
 	exit;
-} elseif ( post_password_required($comment_post_ID) ) {
-	do_action('comment_on_password_protected', $comment_post_ID);
+} elseif ( post_password_required( $comment_post_ID ) ) {
+	/**
+	 * Fires when a comment is attempted on a password-protected post
+	 *
+	 * @since unknown
+	 * @param int $comment_post_ID Post ID
+	 */
+	do_action( 'comment_on_password_protected', $comment_post_ID );
 	exit;
 } else {
-	do_action('pre_comment_on_post', $comment_post_ID);
+	/**
+	 * Fires before a comment is posted
+	 *
+	 * @since unknown
+	 * @param int $comment_post_ID Post ID
+	 */
+	do_action( 'pre_comment_on_post', $comment_post_ID );
 }
 
 $comment_author       = ( isset($_POST['author']) )  ? trim(strip_tags($_POST['author'])) : null;
@@ -90,12 +126,29 @@ $comment_parent = isset($_POST['comment_parent']) ? absint($_POST['comment_paren
 $commentdata = compact('comment_post_ID', 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_content', 'comment_type', 'comment_parent', 'user_ID');
 
 $comment_id = wp_new_comment( $commentdata );
-
 $comment = get_comment($comment_id);
-do_action('set_comment_cookies', $comment, $user);
+
+/**
+ * Perform other actions when comment cookies are set
+ *
+ * @since 3.4.0
+ *
+ * @param object $comment Comment object
+ * @param object $user    WP_User object
+ */
+do_action( 'set_comment_cookies', $comment, $user );
 
 $location = empty($_POST['redirect_to']) ? get_comment_link($comment_id) : $_POST['redirect_to'] . '#comment-' . $comment_id;
-$location = apply_filters('comment_post_redirect', $location, $comment);
+
+/**
+ * The location URI to send commenter after posting
+ *
+ * @since unknown
+ *
+ * @param string $location The 'redirect_to' URI sent via $_POST
+ * @param object $comment  Comment object
+ */
+$location = apply_filters( 'comment_post_redirect', $location, $comment );
 
 wp_safe_redirect( $location );
 exit;