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

お勧め

meta_compare_key使ってみた（2019年3月19日 更新）

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日 更新）

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する（2012年3月15日 更新）

投稿記事に挿入する画像サイズは、サムネイル（150×150）、中サイズ（300×300）、大サイズ（1024×1024）がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」－「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える（2014年9月12日 更新）

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える（2021年9月9日 更新）

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。