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'フィルターが追加され、このフィルターにより実際にゴミ箱に入れるかどうかをコントロールできるようになった。

使用例

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

フィルター

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

アクション

[2.9.0]ゴミ箱に入れる前、wp_trash_postアクションを実行する。 
do_action('wp_trash_post', $post_id);
[2.9.0]ゴミ箱に入れた後、trashed_postアクションを実行する。 
do_action('trashed_post', $post_id);

ソースファイル

/wp-includes/post.php

最終更新 : 2017年11月22日 10:30

関連

参考

Code Reference: wp_trash_post

お勧め

時代はWP_Queryなのか（2011年8月1日 更新）

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

3.6リリース直前チェック（2013年7月26日 更新）

$wpdbは、WordPressのデータベースにアクセスする際に使用できる便利なオブジェクト。独自テーブルの利用やデータ検索の最適化など、標準提供される関数では実現できないことを手助けしてくれる。そんな$wpdbのescapeメソッドが3.6で非推奨（deprecated）になる。

テーブルブロックを投稿メタ（カスタムフィールド）に保存する（2022年1月5日 更新）

ふと「テーブルブロックの内容を投稿メタ（カスタムフィールド）として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。

さくらのVPSでKUSANAGI（2018年5月27日 更新）

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

投稿画面のウェジェットを2列にする（2013年4月17日 更新）

ダッシュボード画面ではスクリーンレイアウトを最大4列まで選択できるのに、投稿画面は1列か2列のどちらか。高解像度のディスプレイを使っていると、投稿画面では大画面のメリットを生かせていない理由がここにあるのではと感じ、3列対応にしてみた。