Changeset 19751 for trunk/wp-includes/comment.php

Timestamp:

01/25/2012 10:41:52 AM (13 years ago)

Author:

westi

Message:

Update the documentation of wp_set_comment_status to match current functionality props solarissmoke.
The 'delete' status was removed in [11749] when the concept of a trash status was introduced for #4529.

File:

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

trunk/wp-includes/comment.php

@@ -1383 +1383 @@
  * Sets the status of a comment.
  *
- * The 'wp_set_comment_status' action is called after the comment is handled and
- * will only be called, if the comment status is either 'hold', 'approve', or
- * 'spam'. If the comment status is not in the list, then false is returned and
- * if the status is 'delete', then the comment is deleted without calling the
- * action.
+ * The 'wp_set_comment_status' action is called after the comment is handled.
+ * If the comment status is not in the list, then false is returned.
  *
  * @since 1.0.0
@@ -1393 +1390 @@
  *
  * @param int $comment_id Comment ID.
- * @param string $comment_status New comment status, either 'hold', 'approve', 'spam', or 'delete'.
+ * @param string $comment_status New comment status, either 'hold', 'approve', 'spam', or 'trash'.
  * @param bool $wp_error Whether to return a WP_Error object if there is a failure. Default is false.
  * @return bool False on failure or deletion and true on success.