wp_restore_post_revision

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

関連

参考

Code Reference: wp_restore_post_revision

お勧め

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

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

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Slightly troublesome permalink：プラグイン作ってみました（2021年4月20日 更新）

カテゴリーを含んだパーマリンクを設定している場合、複数のカテゴリーを指定した投稿記事のパーマリンクのURLに目的のカテゴリーとは異なるカテゴリーが適用された経験はないだろうか。このプラグインは、パーマリンクに適用されるカテゴリーをコントロールし、希望通りのパーマリンクを設定します。

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

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

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