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



お勧め

テーブルブロックを定形に整える(2021年12月27日 更新)

ブロックエディターについて調べていると、「段落ブロックをもう少しカスタマイズした」で使ったRichTextShortcutとは別にショートカットキーを使うためのKeyboardShortcutsが見つかった。今回はこのKeyboardShortcutsを使ってテーブルブロックを定形に整える仕組みを考えてみた。

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

スクリプトファイルのバージョンパラメータを変更する(2018年5月27日 更新)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2018年5月27日 更新)

ダッシュボードの「アクティビティ」ウィジェットは「投稿(post)」の状況を表示し、固定ページ(page)やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。