Changeset 28214

Timestamp:

04/25/2014 06:54:33 AM (11 years ago)

Author:

DrewAPicture

Message:

Ensure the wp_set_comment_status action hook is only documented once.

See #26869.

File:

• trunk/src/wp-includes/comment.php (modified) (2 diffs)

trunk/src/wp-includes/comment.php

@@ -1188 +1188 @@
     clean_comment_cache($comment_id);
 
-    /**
-     * Fires immediately before changing the comment's status to 'delete'.
-     *
-     * @since 1.5.0
-     *
-     * @param int    $comment_id The comment ID.
-     * @param string $status     The new 'delete' comment status.
-     */
+    /** This action is documented in wp-includes/comment.php */
     do_action( 'wp_set_comment_status', $comment_id, 'delete' );
+
     wp_transition_comment_status('delete', $comment->comment_approved, $comment);
     return true;
@@ -1778 +1772 @@
 
     /**
-     * Fires after a comment status has been updated in the database.
-     *
-     * The hook also fires immediately before comment status transition hooks are fired.
+     * Fires immediately before transitioning a comment's status from one to another
+     * in the database.
      *
      * @since 1.5.0
      *
-     * @param int         $comment_id     The comment ID.
-     * @param string|bool $comment_status The comment status. Possible values include 'hold',
-     *                                    'approve', 'spam', 'trash', or false.
+     * @param int         $comment_id     Comment ID.
+     * @param string|bool $comment_status Current comment status. Possible values include
+     *                                    'hold', 'approve', 'spam', 'trash', or false.
      */
     do_action( 'wp_set_comment_status', $comment_id, $comment_status );
+
     wp_transition_comment_status($comment_status, $comment_old->comment_approved, $comment);