wppaste
WordPress

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

Since
2.9.0, 5.6.0
Source
wp-includes/post.php:4090
Restores a post from the Trash.

Compatibility

WordPress
since 5.6.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

$post_idintoptional
Post ID. Default is the ID of the global $post.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_untrash_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
7–68

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

Plugin surface
4 hooks

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

Called by
1

1 place 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 serialize, cache, 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 · 4 distinct outcomes

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

WhenInstructionsCalls it makes
always7–12get_post()
$check !== null27get_post(), get_post_meta(), apply_filters()
$check === null59–60get_post(), get_post_meta(), apply_filters(), do_action(), apply_filters(), delete_post_meta(), delete_post_meta(), ID()
$check === null67–68get_post(), get_post_meta(), apply_filters(), do_action(), apply_filters(), delete_post_meta(), delete_post_meta(), ID(), wp_untrash_post_comments(), do_action()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 73 instructions, 7–68 executed per call, 5 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 · 4

4 hooks fire while wp_untrash_post() runs, in this order:

  1. apply_filters( pre_untrash_post )filterline 4115 (+25 into the body)

    Filters whether a post untrashing should take place.

  2. do_action( untrash_post )actionline 4129 (+39 into the body)

    Fires before a post is restored from the Trash.

  3. apply_filters( wp_untrash_post_status )filterline 4148 (+58 into the body)

    Filters the status that a post gets assigned when it is restored from the trash (untrashed).

  4. do_action( untrashed_post )actionline 4175 (+85 into the body)

    Fires after a post is restored from the Trash.

Uses · 7

Used by · 1

Source code

function wp_untrash_post( $post_id = 0 ) {	$post = get_post( $post_id ); 	if ( ! $post ) {		return $post;	} 	$post_id = $post->ID; 	if ( 'trash' !== $post->post_status ) {		return false;	} 	$previous_status = get_post_meta( $post_id, '_wp_trash_meta_status', true ); 	/**	 * Filters whether a post untrashing should take place.	 *	 * @since 4.9.0	 * @since 5.6.0 Added the `$previous_status` parameter.	 *	 * @param bool|null $untrash         Whether to go forward with untrashing.	 * @param WP_Post   $post            Post object.	 * @param string    $previous_status The status of the post at the point where it was trashed.	 */	$check = apply_filters( 'pre_untrash_post', null, $post, $previous_status );	if ( null !== $check ) {		return $check;	} 	/**	 * Fires before a post is restored from the Trash.	 *	 * @since 2.9.0	 * @since 5.6.0 Added the `$previous_status` parameter.	 *	 * @param int    $post_id         Post ID.	 * @param string $previous_status The status of the post at the point where it was trashed.	 */	do_action( 'untrash_post', $post_id, $previous_status ); 	$new_status = ( 'attachment' === $post->post_type ) ? 'inherit' : 'draft'; 	/**	 * Filters the status that a post gets assigned when it is restored from the trash (untrashed).	 *	 * By default posts that are restored will be assigned a status of 'draft'. Return the value of `$previous_status`	 * in order to assign the status that the post had before it was trashed. The `wp_untrash_post_set_previous_status()`	 * function is available for this.	 *	 * Prior to WordPress 5.6.0, restored posts were always assigned their original status.	 *	 * @since 5.6.0	 *	 * @param string $new_status      The new status of the post being restored.	 * @param int    $post_id         The ID of the post being restored.	 * @param string $previous_status The status of the post at the point where it was trashed.	 */	$post_status = apply_filters( 'wp_untrash_post_status', $new_status, $post_id, $previous_status ); 	delete_post_meta( $post_id, '_wp_trash_meta_status' );	delete_post_meta( $post_id, '_wp_trash_meta_time' ); 	$post_updated = wp_update_post(		array(			'ID'          => $post_id,			'post_status' => $post_status,		)	); 	if ( ! $post_updated ) {		return false;	} 	wp_untrash_post_comments( $post_id ); 	/**	 * Fires after a post is restored from the Trash.	 *	 * @since 2.9.0

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.

5.6.0
An untrashed post is now returned to 'draft' status by default, except for attachments which are returned to their original 'inherit' status.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/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.