wp_trash_post( int $post_id = 0 ): WP_Post|false|null

Description

Compatibility

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

Parameters

$post_idintoptional

Post ID. Default is the ID of the global $post if EMPTY_TRASH_DAYS equals true.Default: 0

Return value

WP_Post|false|null

Post data on success, false or null on failure.

Performance profile

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

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

8–54

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

Plugin surface

3 hooks

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

Called by

7

7 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 callbacksapply_filters()called directly

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

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

Hooks and filters fired · 3

3 hooks fire while wp_trash_post() runs, in this order:

1. 1
   apply_filters( pre_trash_post )filterline 3911 (+27 into the body)

   Filters whether a post trashing should take place.

2. 2
   do_action( wp_trash_post )actionline 3926 (+42 into the body)

   Fires before a post is sent to the Trash.

3. 3
   do_action( trashed_post )actionline 3953 (+69 into the body)

   Fires after a post is sent to the Trash.

Uses · 7

• wp_delete_post()Trashes or deletes a post or page.
• get_post()Retrieves post data given a post ID or post object.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• 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.
• wp_update_post()Updates a post with new post data.
• wp_trash_post_comments()Moves comments for a post to the Trash.

Used by · 7

• WP_REST_Posts_Controller::delete_item()Deletes a single post.
• WP_REST_Templates_Controller::delete_item()Deletes a single template.
• _wp_delete_customize_changeset_dependent_auto_drafts()Deletes auto-draft posts associated with the supplied changeset.
• _wp_keep_alive_customize_changeset_dependent_auto_drafts()Makes sure that auto-draft posts get their post_date bumped or status changed to draft to prevent premature garbage-collection.
• wp_ajax_trash_post()Handles sending a post to the Trash via AJAX.
• wp_delete_attachment()Trashes or deletes an attachment.
• wp_delete_post()Trashes or deletes a post or page.

Source code

View on Trac ↗View on GitHub ↗

3884function wp_trash_post( $post_id = 0 ) {3885	if ( ! EMPTY_TRASH_DAYS ) {3886		return wp_delete_post( $post_id, true );3887	}3888 3889	$post = get_post( $post_id );3890 3891	if ( ! $post ) {3892		return $post;3893	}3894 3895	if ( 'trash' === $post->post_status ) {3896		return false;3897	}3898 3899	$previous_status = $post->post_status;3900 3901	/**3902	 * Filters whether a post trashing should take place.3903	 *3904	 * @since 4.9.03905	 * @since 6.3.0 Added the `$previous_status` parameter.3906	 *3907	 * @param bool|null $trash           Whether to go forward with trashing.3908	 * @param WP_Post   $post            Post object.3909	 * @param string    $previous_status The status of the post about to be trashed.3910	 */3911	$check = apply_filters( 'pre_trash_post', null, $post, $previous_status );3912 3913	if ( null !== $check ) {3914		return $check;3915	}3916 3917	/**3918	 * Fires before a post is sent to the Trash.3919	 *3920	 * @since 3.3.03921	 * @since 6.3.0 Added the `$previous_status` parameter.3922	 *3923	 * @param int    $post_id         Post ID.3924	 * @param string $previous_status The status of the post about to be trashed.3925	 */3926	do_action( 'wp_trash_post', $post_id, $previous_status );3927 3928	add_post_meta( $post_id, '_wp_trash_meta_status', $previous_status );3929	add_post_meta( $post_id, '_wp_trash_meta_time', time() );3930 3931	$post_updated = wp_update_post(3932		array(3933			'ID'          => $post_id,3934			'post_status' => 'trash',3935		)3936	);3937 3938	if ( ! $post_updated ) {3939		return false;3940	}3941 3942	wp_trash_post_comments( $post_id );3943 3944	/**3945	 * Fires after a post is sent to the Trash.3946	 *3947	 * @since 2.9.03948	 * @since 6.3.0 Added the `$previous_status` parameter.3949	 *3950	 * @param int    $post_id         Post ID.3951	 * @param string $previous_status The status of the post at the point where it was trashed.3952	 */3953	do_action( 'trashed_post', $post_id, $previous_status );3954 3955	return $post;3956}

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.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 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.