wppaste
WordPress

wp_trash_comment( int|WP_Comment $comment_id ): bool

Since
2.9.0, 6.9.0
Source
wp-includes/comment.php:1585
Moves a comment to the Trash

Description

If Trash is disabled, comment is permanently deleted.

Compatibility

WordPress
since 6.9.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$comment_idint|WP_Comment
Comment ID or WP_Comment object.

Return value

bool
True on success, false on failure.

Performance profile

How much work a call to wp_trash_comment() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Light

Touches nothing outside its own arguments.

Scaling
Scales with input

The body loops, so the work grows with what you pass in.

Instructions
9–73

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 116.

Plugin surface
2 hooks

Third-party callbacks on 'trash_comment', 'trashed_comment' run inside this call, and their cost is not bounded by anything here.

Called by
5

5 places in core call this, so the cost is paid more often than your own code shows.

What it touches

  • hookthird-party callbacksdo_action()called directly

Further down the call graph this can also reach cache, serialize, query, option and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_trash_comment() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always9get_comment()
always14–22get_comment(), wp_delete_comment()
!wp_set_comment_status()21get_comment(), do_action(), wp_set_comment_status()
always28–29get_comment(), wp_delete_comment(), ->get_children()
wp_set_comment_status()61–65get_comment(), do_action(), wp_set_comment_status(), delete_comment_meta(), delete_comment_meta(), add_comment_meta(), time(), add_comment_meta(), do_action()
wp_set_comment_status()72–73get_comment(), do_action(), wp_set_comment_status(), delete_comment_meta(), delete_comment_meta(), add_comment_meta(), time(), add_comment_meta(), do_action(), ->get_children()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 116 instructions, 9–73 executed per call, 15 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Hooks and filters fired · 2

2 hooks fire while wp_trash_comment() runs, in this order:

  1. do_action( trash_comment )actionline 1628 (+43 into the body)

    Fires immediately before a comment is sent to the Trash.

  2. do_action( trashed_comment )actionline 1645 (+60 into the body)

    Fires immediately after a comment is sent to Trash.

Uses · 7

Used by · 5

Source code

View on Trac View on GitHub 

function wp_trash_comment( $comment_id ) {	if ( ! EMPTY_TRASH_DAYS ) {		$comment = get_comment( $comment_id );		$success = wp_delete_comment( $comment_id, true ); 		if ( ! $success ) {			return false;		} 		// Also delete children of top level 'note' type comments.		if ( $comment && 'note' === $comment->comment_type && 0 === (int) $comment->comment_parent ) {			$children = $comment->get_children(				array(					'fields' => 'ids',					'status' => 'all',					'type'   => 'note',				)			); 			foreach ( $children as $child_id ) {				if ( ! wp_delete_comment( $child_id, true ) ) {					$success = false;				}			}		} 		return $success;	} 	$comment = get_comment( $comment_id );	if ( ! $comment ) {		return false;	} 	/**	 * Fires immediately before a comment is sent to the Trash.	 *	 * @since 2.9.0	 * @since 4.9.0 Added the `$comment` parameter.	 *	 * @param string     $comment_id The comment ID as a numeric string.	 * @param WP_Comment $comment    The comment to be trashed.	 */	do_action( 'trash_comment', $comment->comment_ID, $comment ); 	if ( wp_set_comment_status( $comment, 'trash' ) ) {		delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_status' );		delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_time' );		add_comment_meta( $comment->comment_ID, '_wp_trash_meta_status', $comment->comment_approved );		add_comment_meta( $comment->comment_ID, '_wp_trash_meta_time', time() ); 		/**		 * Fires immediately after a comment is sent to Trash.		 *		 * @since 2.9.0		 * @since 4.9.0 Added the `$comment` parameter.		 *		 * @param string     $comment_id The comment ID as a numeric string.		 * @param WP_Comment $comment    The trashed comment.		 */		do_action( 'trashed_comment', $comment->comment_ID, $comment ); 		// For top level 'note' type comments, also trash children.		if ( 'note' === $comment->comment_type && 0 === (int) $comment->comment_parent ) {			$children = $comment->get_children(				array(					'fields' => 'ids',					'status' => 'all',					'type'   => 'note',				)			); 			$success = true;			foreach ( $children as $child_id ) {				if ( ! wp_trash_comment( $child_id ) ) {					$success = false;				}			}			return $success;		}

Changelog

Introduced in 2.9.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

6.9.0
Any child notes are deleted when deleting a note.from the docblock
2.9.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/comment.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.