From b285909d015690b42522f5b67a998579b4c99ba6 Mon Sep 17 00:00:00 2001 From: Peter Westwood Date: Wed, 25 Jan 2012 10:41:52 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@19751 602fd350-edb4-49c9-b593-d223f7449a82 --- wp-includes/comment.php | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/wp-includes/comment.php b/wp-includes/comment.php index cddf0be2ed..dd4179cc27 100644 --- a/wp-includes/comment.php +++ b/wp-includes/comment.php @@ -1382,17 +1382,14 @@ function wp_new_comment( $commentdata ) { /** * 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 * @uses wp_transition_comment_status() Passes new and old comment status along with $comment object * * @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. */