wp_untrash_post() の使い方｜説明・引数・注意点

説明

基本構文

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

引数

• $post_id：投稿ID

戻り値

復元した投稿オブジェクト。失敗時は false または null。

使い方（サンプル）

wp_untrash_post( 123 );

注意点

• 復元後の状態は、既定では下書き（draft）になります。

実務での使いどころ

• ゴミ箱の投稿を、元に戻すとき。
• 誤って削除した投稿を、プログラムから復元するとき。

よくあるミスと対処

• 元のステータスに戻ると思っている。WordPress 5.6以降、既定では下書きとして復元される。
• ゴミ箱の投稿は、一定期間後に自動で完全削除される。復元するなら、その前に行う。

NG例

wp_untrash_post( $post_id ); // 公開状態に戻ると思っている

OK例

$restored = wp_untrash_post( $post_id );
if ( $restored ) {
	wp_update_post( array( 'ID' => $post_id, 'post_status' => 'publish' ) );
}

使い分け早見表

関連項目

wp_trash_post()、wp_delete_post()、wp_update_post()

公式リファレンス：wp_untrash_post() | Function | WordPress Developer Resources