wp_restore_post_revision

説明

mixed wp_restore_post_revision( int|WP_Post $revision_id [ , array $fields = null ] )
リビジョンの内容を投稿へ戻す。

パラメータ

  • $revision_id
    リビジョンIDまたはリビジョン情報(オブジェクト)を指定。
  • $fields
    更新するデータ項目を配列で指定(省略時はnull)。

返り値

リビジョンの内容を元の投稿情報へ書き戻した場合は投稿IDを返す。書き戻せなかった場合はfalse、null、WP_Errorオブジェクトのいずかを返す。


注意

パラメータ$fieldsがnullの場合、更新するデータ項目は'post_title'、'post_content'、'post_excerpt'となる。なお$fieldsの内容としてこれら3つ以外のデータ項目('ID'や'post_name'、'post_type'など)を指定しても無効となり、書き戻しの対象とはならない。

返り値のエラー判定はWP_Errorオブジェクトを考慮して真偽判定のみで行わないこと。


使用例

  • リビジョンの内容を投稿へ戻す。
    <?php wp_restore_post_revision( $revision_id ); ?>
  • リビジョンの本文部分を投稿へ戻す。
    <?php wp_restore_post_revision( $revision_id, array( 'post_content' ) ); ?>

フィルター

実行するフィルターはありません。

アクション

[2.6.0]リビジョンの内容を書き戻した場合に'wp_restore_post_revision'アクションを呼び出す。パラメータ$post_idには元の投稿IDが、$revision_IDにはリビジョンIDが格納されている。
do_action( 'wp_restore_post_revision', $post_id, $revision_ID );

ソースファイル

/wp-includes/revision.php

最終更新 : 2018年08月29日 15:27



お勧め

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

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

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 更新)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

管理画面でよく使うスタイルをまとめてみた「メッセージ編」(2019年7月30日 更新)

標準で用意されているスタイルを知っておくことで、独自に用意するスタイルを軽減でき、機能拡張した部分の見た目は違和感が少なくなる。そんな共通要素のスタイルのひとつが「メッセージ」だ。メッセージにはいくつかの意味合いがあり、用途に応じてすぐに使い分けすることになる。今回はそんなメッセージ向けのスタイルをざっくりまとめてみた。