WordPress.org

Description

Moves comments for a post to the trash

Usage

 <?php wp_trash_post_comments( $post_id ); ?>

Parameters

$post_id

(integer) (optional) Post ID.

Default: 0

Return Values

(mixed) 

False on failure.

Notes

• Uses: do_action() on 'trash_post_comments' before trashing.
• Uses: do_action() on 'trashed_post_comments' after trashing.
• Uses: clean_comment_cache()

Change Log

Since: 2.9.0

Source File

wp_trash_post_comments() is located in wp-includes/post.php.

Related

wp_untrash_post_comments(), wp_trash_post(), wp_delete_post(), clean_comment_cache()