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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

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

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

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。