説明
mixed wp_untrash_post( [ int $post_id = 0 ] )
投稿情報をゴミ箱から取り出す。
パラメータ
- $post_id投稿情報IDを指定（省略時は0）。
返り値
ゴミ箱から取り出した場合はその投稿情報を返す。投稿情報が見つからなかった場合はnull、すでにゴミ箱に入っていなかった場合はfalseを返す。注意
[4.9.0]'pre_untrash_post'フィルターが追加され、このフィルターにより実際にゴミ箱から取り出すかどうかをコントロールできるようになった。
[5.6.0]'wp_untrash_post_status'フィルターが追加され、ゴミ箱から取り出した際のステータスをコントロールできるようになった。また、各アクションおよびフィルターのパラメータにゴミ箱に入る前のステータスが追加された。
使用例
- 投稿IDが10の投稿情報をゴミ箱から取り出す。<?php wp_untrash_post( 10 ); ?>
フィルター
[4.9.0]投稿情報のステータスが'trash'でないことを確認した後（'untrash_post'アクションの前）、'pre_untrash_post'フィルターを呼び出す。パラメータ$checkの既定値はnull（処理を継続する場合はnullを返す）が、$postには投稿情報が格納されている。[5.6.0]$previous_statusにはゴミ箱に入る前のステータスが格納されている。$check = apply_filters( 'pre_untrash_post', $check, $post, $previous_status );
if ( null !== $check ) {
return $check;
}
$post_status = apply_filters( 'wp_untrash_post_status', $new_status, $post_id, $previous_status );アクション
[2.9.0]ゴミ箱から取り出す前、'untrash_post'アクションを実行する。[5.6.0]$previous_statusにはゴミ箱に入る前のステータスが格納されている。do_action( 'untrash_post', $post_id, $previous_status );do_action( 'untrashed_post', $post_id, $previous_status );ソースファイル
/wp-includes/post.php最終更新 : 2020年12月16日 15:27
関連
お勧め
5.5で非推奨になる関数名について（2020年8月12日 更新）
来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2（以降Beta 2）」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。
meta_compare_key使ってみた（2019年3月19日 更新）
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。
プラグインの設定ページもレスポンシブ対応（2014年6月3日 更新）
レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。
初期化に関連するアクションのおさらい（2013年11月27日 更新）
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。全投稿を取得するのはnopaging=1でいい（2011年8月31日 更新）
query_posts関数（またはWP_Queryクラス）を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」－「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには？