wp_trash_post_comments( int|WP_Post|null $post = null ): int|false|null

Compatibility

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

Parameters

$postint|WP_Post|nulloptional

Post ID or post object. Defaults to global $post.Default: null

Return value

int|false|null

int if the comments were successfully deleted, false on failure and null if the post or comment did not exist.

Performance profile

How much work a call to wp_trash_post_comments() 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

Heavy

Reaches the database via ->get_results().

Scaling

Scales with input

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

Instructions

8–55

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

Plugin surface

2 hooks

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

Called by

2

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

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksdo_action()called directly
• sqldatabase query->get_results()called directly
• cacheobject cachewp_cache_delete_multiple()one call below wp_trash_post_comments()

Further down the call graph this can also reach serialize, 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 · 3 distinct outcomes

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

Hooks and filters fired · 2

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

1. 1
   do_action( trash_post_comments )actionline 4286 (+18 into the body)

   Fires before comments are sent to the Trash.

2. 2
   do_action( trashed_post_comments )actionline 4314 (+46 into the body)

   Fires after comments are sent to the Trash.

Uses · 4

• get_post()Retrieves post data given a post ID or post object.
• do_action()Calls the callback functions that have been added to an action hook.
• add_post_meta()Adds a meta field to the given post.
• clean_comment_cache()Removes a comment from the object cache.

Used by · 2

• WP_Customize_Manager::trash_changeset_post()Trashes or deletes a changeset post.
• wp_trash_post()Moves a post or page to the Trash

Source code

View on Trac ↗View on GitHub ↗

4268function wp_trash_post_comments( $post = null ) {4269	global $wpdb;4270 4271	$post = get_post( $post );4272 4273	if ( ! $post ) {4274		return null;4275	}4276 4277	$post_id = $post->ID;4278 4279	/**4280	 * Fires before comments are sent to the Trash.4281	 *4282	 * @since 2.9.04283	 *4284	 * @param int $post_id Post ID.4285	 */4286	do_action( 'trash_post_comments', $post_id );4287 4288	$comments = $wpdb->get_results( $wpdb->prepare( "SELECT comment_ID, comment_approved FROM $wpdb->comments WHERE comment_post_ID = %d", $post_id ) );4289 4290	if ( ! $comments ) {4291		return null;4292	}4293 4294	// Cache current status for each comment.4295	$statuses = array();4296	foreach ( $comments as $comment ) {4297		$statuses[ $comment->comment_ID ] = $comment->comment_approved;4298	}4299	add_post_meta( $post_id, '_wp_trash_meta_comments_status', $statuses );4300 4301	// Set status for all comments to post-trashed.4302	$result = $wpdb->update( $wpdb->comments, array( 'comment_approved' => 'post-trashed' ), array( 'comment_post_ID' => $post_id ) );4303 4304	clean_comment_cache( array_keys( $statuses ) );4305 4306	/**4307	 * Fires after comments are sent to the Trash.4308	 *4309	 * @since 2.9.04310	 *4311	 * @param int   $post_id  Post ID.4312	 * @param array $statuses Array of comment statuses.4313	 */4314	do_action( 'trashed_post_comments', $post_id, $statuses );4315 4316	return $result;4317}

Changelog

Introduced in 2.9.0. One change between 6.7.7 and 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.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/post.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.