wp_untrash_post

説明

mixed wp_untrash_post( [ int $post_id = 0 ] )
投稿情報をゴミ箱から取り出す。

パラメータ

  • $post_id
    投稿情報IDを指定(省略時は0)。

返り値

ゴミ箱から取り出した場合はその投稿情報を返す。投稿情報が見つからなかった場合はnull、すでにゴミ箱に入っていなかった場合はfalseを返す。

注意

[4.9.0]'pre_untrash_post'フィルターが追加され、このフィルターにより実際にゴミ箱から取り出すかどうかをコントロールできるようになった。


使用例

  • 投稿IDが10の投稿情報をゴミ箱から取り出す。
    <?php wp_untrash_post( 10 ); ?>

フィルター

[4.9.0]投稿情報のステータスが'trash'でないことを確認した後('untrash_post'アクションの前)、'pre_untrash_post'フィルターを呼び出す。パラメータ$checkの既定値はnull(処理を継続する場合はnullを返す)が、$postには投稿情報が格納されている。
$check = apply_filters( 'pre_untrash_post', $check, $post );
if ( null !== $check ) {
	return $check;
}

アクション

[2.9.0]ゴミ箱から取り出す前、'untrash_post'アクションを実行する。
do_action('untrash_post', $post_id);
[2.9.0]ゴミ箱から取り出した後、'untrashed_post'アクションを実行する。
do_action('untrashed_post', $post_id);

ソースファイル

/wp-includes/post.php

最終更新 : 2018年05月27日 10:43



お勧め

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 更新)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

タイトルが一致する投稿を検索する(2014年2月20日 更新)

WordPressが提供する投稿ページの文字列検索機能の実現には、 query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

WordPressの鼓動(2013年10月1日 更新)

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。