WordPress.org

Description

Trashes or deletes a comment.

The comment is moved to trash instead of permanently deleted unless trash is disabled, item is already in the trash, or $force_delete is true.

The post comment count will be updated if the comment was approved and has a post ID available.

Usage

<?php wp_delete_comment( $comment_id, $force_delete ) ?>

Parameters

$comment_id

(integer) (required) Comment ID

Default: None

$force_delete

(boolean) (optional) Move comment to trash or delete.

Default: false

Return Values

(boolean) 

False if delete comment query failure, true on success.

Examples

Notes

• Uses: $wpdb
• Uses: do_action() Calls 'delete_comment' hook on comment ID
• Uses: do_action() Calls 'wp_set_comment_status' hook on comment ID with 'delete' set for the second parameter
• Uses: wp_transition_comment_status() Passes new and old comment status along with $comment object
• Uses: get_comment()
• Uses: wp_update_comment_count() to decrease count on success.
• Uses: clean_comment_cache() to remove comment form cache on success.

Change Log

Since: 2.0.0

Source File

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

Related