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



お勧め

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 更新)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

Somewhere search box:プラグイン作ってみました(2018年5月8日 更新)

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

32ピクセルのサイトアイコンを別の画像ファイルに変更する(2018年5月27日 更新)

「サイトアイコン」は4.3の新機能の1つ。管理画面で適当な画像ファイルを指定するだけでサイトアイコンが適用されます。そんなサイトアイコンで、既存の favicon.ico を併用する方法を紹介します。