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



お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

リクエスト応答を終了する前に何かを処理する(2013年9月26日 更新)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

段落ブロックに日付・時刻の入力支援を実装した(2023年1月25日 更新)

ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。

ブロックエディターのタグ入力にタグクラウド機能を追加した(2019年1月10日 更新)

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。