Changeset 25249

Timestamp:

09/05/2013 04:04:17 PM (11 years ago)

Author:

nacin

Message:

Inline documentation for hooks in wp-comments-post.php.

props rzen.
see #25229.

File:

• trunk/src/wp-comments-post.php (modified) (3 diffs)

trunk/src/wp-comments-post.php

@@ -22 +22 @@
 $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;
 }
@@ -32 +38 @@
 $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 );
 }
 
@@ -91 +127 @@
 
 $comment_id = wp_new_comment( $commentdata );
+$comment = get_comment($comment_id);
 
-$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 );