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

関連

お勧めコンテンツ

4.4では投稿ページも専用テンプレートが適用できる(2015年11月7日 登録)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

囲み型ショートコードとwpautop(2014年10月22日 登録)

ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。

Widgets on dashboard:プラグイン作ってみました(2014年5月6日 登録)

サイトバーなどのページ構成パーツとしてウィジェットを利用し、ある程度頻繁に更新している場合、毎回ウィジェットページを表示するのはちょっとだけ面倒かも。そんなわけで、シンプルにダッシュボードで直接編集できればいいかなと思い、調べてみました。

Login rebuilderのログ表示機能を紹介(2015年7月9日 登録)

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 登録)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

最終更新日時 : 2017-11-22 10:30