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

説明

基本構文

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

引数

• $post_id：投稿ID

戻り値

ゴミ箱に移動した投稿オブジェクト。失敗時は false または null。

使い方（サンプル）

wp_trash_post( 123 );

注意点

• 元に戻すには wp_untrash_post() を使います。
• ゴミ箱は一定期間（既定30日）後に自動削除されます。

実務での使いどころ

• 投稿を、ゴミ箱に移動するとき（復元できる削除）。
• 不要になった投稿を、いったん取り下げて保管しておくとき。

よくあるミスと対処

• 完全に削除されたと思っている。ゴミ箱の投稿は、一定期間（既定は30日）は残り、復元できる。
• EMPTY_TRASH_DAYS が 0 のサイトでは、ゴミ箱が無効のため、完全に削除される。

NG例

wp_trash_post( $post_id ); // ゴミ箱が無効なサイトでは、完全に削除される

OK例

if ( defined( 'EMPTY_TRASH_DAYS' ) && EMPTY_TRASH_DAYS ) {
	wp_trash_post( $post_id ); // 復元できる
}

使い分け早見表

関連項目

wp_delete_post()、wp_untrash_post()

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