wp_trash_post

（2.9.0以降）
wp_trash_post - 投稿情報をゴミ箱に入れる

説明

mixed wp_trash_post( [ int $post_id = 0 ] )
投稿情報をゴミ箱に入れる。

パラメータ

  • $post_id
    投稿情報IDを指定（省略時は0）。

返り値

ゴミ箱に入れた場合はその投稿情報を返す。投稿情報が見つからなかった場合はnull、すでにゴミ箱に入っている場合はfalseを返す。

注意

EMPTY_TRASH_DAYS（デフォルトは30）が0の場合、ゴミ箱には入れず、 wp_delete_post関数を呼び出して投稿情報を削除する。

[4.9.0]'pre_trash_post'フィルターが追加され、このフィルターにより実際にゴミ箱に入れるかどうかをコントロールできるようになった。

[6.3.0]'pre_trash_post'フィルター、'wp_trash_post'アクションのコールバック関数向けのパラメータに$previous_statusが追加された。その中にはゴミ箱に入れる前のステータスが格納されている。

使用例

  • 投稿IDが10の投稿情報をゴミ箱に入れる。
    <?php wp_trash_post( 10 ); ?>

フィルター

[4.9.0]投稿情報のステータスが'trash'なことを確認した後（'wp_trash_post'アクションの前）、'pre_trash_post'フィルターを呼び出す。パラメータ$checkの既定値はnull（処理を継続する場合はnullを返す）が、$postには投稿情報が格納されている。[6.3.0]パラメータ$previous_statusが追加され、ゴミ箱に入れる前のステータスが格納されている。 
$check = apply_filters( 'pre_trash_post', $check, $post, $previous_status );
if ( null !== $check ) {
	return $check;
}

アクション

[2.9.0]ゴミ箱に入れる前、wp_trash_postアクションを実行する。パラメータ$post_idには本関数が受け取った内容が格納されている。[6.3.0]パラメータ$previous_statusが追加され、ゴミ箱に入れる前のステータスが格納されている。 
do_action( 'wp_trash_post', $post_id, $previous_status );
[2.9.0]ゴミ箱に入れた後、trashed_postアクションを実行する。 
do_action( 'trashed_post', $post_id );

ソースファイル

/wp-includes/post.php

最終更新 : 2023年08月10日 15:16

関連

参考

Code Reference: wp_trash_post

お勧め

ブロックエディターの色設定を変えてみる（2019年12月11日 更新）

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

「姓」の後に「名」を（2013年11月6日 更新）

WordPressのユーザー情報設定ページでは、「名（First name）」の後に「姓（Last name）」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。

ホームディレクトリから過去のファイルを削除する（2013年1月27日 更新）

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

Login rebuilder 2.6.5の新機能紹介（2021年3月8日 更新）

今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。

投稿情報を連想配列で参照する（2018年5月27日 更新）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。