wp_untrash_post

（2.9.0以降）
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

関連

参考

Code Reference: wp_untrash_post

お勧め

Emojin：プラグイン作ってみました（2015年3月21日 更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。