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



お勧め

パスとURL(2011年10月6日 更新)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。