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



お勧め

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

the_date関数で投稿日を確実に表示する(2011年12月20日 更新)

投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。

xmlrpc.phpへのアクセスについてちょっと考えた(2018年5月27日 更新)

少し前のことですが、こちらのサーバーを何度かダウンさせてしまったのですが、その原因はxmlrpc.phpへアクセスが集中したことによってサーバーが過負荷となってしまったというものでした。すぐにサーバー性能を上げることはできないため、xmlrpc.phpのアクセスを全部拒否するという暫定対応してしまいました。

メディアライブラリに絞り込み用の「投稿タグ」を追加する(2014年6月24日 更新)

この記事は、先月投稿したコラム「メディア(attachment)を拡張してより便利に活用する」の続編。メディアで「投稿タグ」を追加するだけで「メディアライブラリ」ページの投稿一覧の中には「タグ」カラムが追加されるが、今回はその「投稿タグ」で絞り込み検索に対応してみる。