A WordPress-centric search engine for devs and theme authors



wp_untrash_post ›

Since2.9.0
Deprecatedn/a
wp_untrash_post ( $post_id = 0 )
Parameters:
  • (int) $post_id Optional. Post ID. Default is ID of the global $post.
    Required: No
    Default:
Returns:
  • (WP_Post|false|null) Post data on success, false or null on failure.
Defined at:
Codex:

Restore a post or page from the Trash.



Source

function wp_untrash_post( $post_id = 0 ) {
	$post = get_post( $post_id );

	if ( ! $post ) {
		return $post;
	}

	if ( 'trash' !== $post->post_status ) {
		return false;
	}

	/**
	 * Filters whether a post untrashing should take place.
	 *
	 * @since 4.9.0
	 *
	 * @param bool    $untrash Whether to go forward with untrashing.
	 * @param WP_Post $post    Post object.
	 */
	$check = apply_filters( 'pre_untrash_post', null, $post );
	if ( null !== $check ) {
		return $check;
	}

	/**
	 * Fires before a post is restored from the trash.
	 *
	 * @since 2.9.0
	 *
	 * @param int $post_id Post ID.
	 */
	do_action( 'untrash_post', $post_id );

	$post_status = get_post_meta( $post_id, '_wp_trash_meta_status', true );

	delete_post_meta( $post_id, '_wp_trash_meta_status' );
	delete_post_meta( $post_id, '_wp_trash_meta_time' );

	wp_update_post(
		array(
			'ID'          => $post_id,
			'post_status' => $post_status,
		)
	);

	wp_untrash_post_comments( $post_id );

	/**
	 * Fires after a post is restored from the trash.
	 *
	 * @since 2.9.0
	 *
	 * @param int $post_id Post ID.
	 */
	do_action( 'untrashed_post', $post_id );

	return $post;
}