Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-11-12 13:44:21 +01:00
Code Issues Projects Releases Wiki Activity

Update the documentation of wp_set_comment_status to match current functionality props solarissmoke.

Browse Source 
The 'delete' status was removed in [11749] when the concept of a trash status was introduced for #4529.

git-svn-id: http://svn.automattic.com/wordpress/trunk@19751 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
westi 2012-01-25 10:41:52 +00:00
parent 68feb8ef19
commit c54927be82
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
wp-includes/comment.php
View File

@ -1382,17 +1382,14 @@ function wp_new_comment( $commentdata ) {
/** /**
* Sets the status of a comment. * Sets the status of a comment.
* *
* The 'wp_set_comment_status' action is called after the comment is handled and * The 'wp_set_comment_status' action is called after the comment is handled.
* will only be called, if the comment status is either 'hold', 'approve', or * If the comment status is not in the list, then false is returned.
* '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.
* *
* @since 1.0.0 * @since 1.0.0
* @uses wp_transition_comment_status() Passes new and old comment status along with $comment object * @uses wp_transition_comment_status() Passes new and old comment status along with $comment object
* *
* @param int $comment_id Comment ID. * @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. * @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. * @return bool False on failure or deletion and true on success.
*/ */