WordPress.org

Function Reference/wp set comment status

Description

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.

Usage

<?php wp_set_comment_status( $comment_id, $comment_status ) ?>

Parameters

$comment_id

(integer) (required) Comment ID.

Default: None

$comment_status

(string) (required) New comment status, either 'hold', 'approve', 'spam', or 'trash'.

Default: None

Return Values

(boolean): False on failure or deletion and true on success.

Examples

Notes

Uses: wp_transition_comment_status() Passes new and old comment status along with $comment object
Uses: wp_notify_postauthor()
Uses: get_option()
Uses: wp_delete_comment()
Uses: clean_comment_cache()
Uses: get_comment()
Uses: wp_transition_comment_status()
Uses: wp_update_comment_count()
Uses global: (object) $wpdb

Change Log

Since 2.9: $comment_status: the parameter 'delete' was replaced with 'trash'. Comments will be added to the Comment Trash instead of being purged from the database.

Since: 1.0.0

Source File

wp_set_comment_status() is located in wp-includes/comment.php.

WordPress.org

Codex

Function Reference/wp set comment status

Contents