wp_untrash_post

説明

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;
}
[5.6.0]'untrash_post'アクションの後、'wp_untrash_post_status'フィルターを呼び出す。パラメータ$new_statusには取り出し後のステータスが、$post_idには投稿IDが、$previous_statusにはゴミ箱に入る前のステータスが格納されている。
$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 );
[2.9.0]ゴミ箱から取り出した後、'untrashed_post'アクションを実行する。[5.6.0]$previous_statusにはゴミ箱に入る前のステータスが格納されている。
do_action( 'untrashed_post', $post_id, $previous_status );

ソースファイル

/wp-includes/post.php

最終更新 : 2020年12月16日 15:27



お勧め

4.2.3でちょっと変わったショートコード(2018年5月27日 更新)

4.3のリリースまであと少しなわけですが、4.2.3が緊急リリースされました。4.2.2とソースコードを比較すると、ざっくりTinyMCE絡みが多い印象を受けたのですが、ショートコード関連も少し変わっていたので簡単にまとめてみました。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

Gutenbergエディターのフォントを変える(2018年10月16日 更新)

Gutenbergエディターを試していてしっくりこないのが、編集時とそれを投稿した際の見た目の違い。GutenbergエディターとテーマTwenty Seventeenとではまったく異なるタイプのフォントが適用されていることが大きな理由である。

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。