ワードプレスのwp_restore_post_revision関数の使用方法・解説

2025年2月22日カスタムポストタイプ、タクソノミー、ワードプレスコア、投稿

概要

wp_restore_post_revision 関数は、WordPress のリビジョン機能を利用して、特定の投稿の過去のバージョンを復元するために使用されます。この関数は主に、投稿の内容を過去の状態に戻したい場合や、誤って削除・変更してしまった内容を復元したい場合に役立ちます。

この関数は、以下のようなシナリオでよく使用されます：

投稿やページの間違った編集の元に戻すとき
画像やメディアの変更をリセットする際
誤って削除してしまった内容の復元
グループブログなどで、他のユーザーによる変更を取り消す場合
サイトのコンテンツ変更を段階的に検討したいとき
過去の状態に基づいて新しい草稿を作成するための参考として
リビジョン履歴を確認する際の視覚的な比較の一環として
バージョン管理としての役割を果たすために

構文

wp_restore_post_revision( $revision );

パラメータ

$revision (int) – 復元したいリビジョンの投稿 ID。

戻り値

成功した場合は、復元された投稿オブジェクトの ID を返し、失敗した場合は false を返します。

関連する関数

使用可能なバージョン

この関数は、WordPress 3.6 以降で利用可能です。

コアファイルのパス

wp-includes/revision.php

サンプルコード

サンプルコード 1: リビジョンの復元

このコードは、特定のリビジョンを指定して投稿のリビジョンを復元する例です。

$revision_id = 123; // 復元したいリビジョンのID
$result = wp_restore_post_revision( $revision_id );

if ( $result ) {
    echo 'リビジョンが正常に復元されました。';
} else {
    echo 'リビジョンの復元に失敗しました。';
}

引用元: https://developer.wordpress.org/reference/functions/wp_restore_post_revision/

サンプルコード 2: フロントエンドでの復元ボタン

このコードは、投稿のリビジョンを復元するためのボタンを作成する例です。

$revision_id = 123; // 復元したいリビジョンのID
echo '<a href="' . esc_url( add_query_arg( 'restore_revision', $revision_id, get_permalink() ) ) . '">このリビジョンを復元する</a>';

引用元: https://developer.wordpress.org/reference/functions/wp_restore_post_revision/

サンプルコード 3: 投稿のリビジョンリスト表示

このコードは、投稿のリビジョンをリスト表示し、各リビジョンを復元できるリンクを生成します。

$revisions = wp_get_post_revisions( $post_id );
foreach ( $revisions as $revision ) {
    echo '<li><a href="' . esc_url( admin_url( 'edit.php?post=' . $revision->ID . '&action=wp_restore_post_revision' ) ) . '">' . $revision->post_date . ' にリビジョンを復元する</a></li>';
}

引用元: https://developer.wordpress.org/reference/functions/wp_restore_post_revision/

サンプルコード 4: 投稿のリビジョンを取得して復元する

このコードは、特定の投稿の最新のリビジョンを取得し、自動的に復元します。

$post_id = 1; // 投稿ID
$revisions = wp_get_post_revisions( $post_id );
if ( ! empty( $revisions ) ) {
    $latest_revision = reset( $revisions );
    wp_restore_post_revision( $latest_revision->ID );
}

引用元: https://developer.wordpress.org/reference/functions/wp_restore_post_revision/

サンプルコード 5: リビジョンの復元時のフック

このコードは、リビジョン復元後にカスタムアクションを実行する例です。

add_action( 'wp_restore_post_revision', 'custom_action_on_revision_restore', 10, 2 );

function custom_action_on_revision_restore( $revision_id, $post_id ) {
    // リビジョンが復元された場合の処理
}

引用元: https://developer.wordpress.org/reference/functions/wp_restore_post_revision/

この関数のアクションでの使用可能性

アクション名	使用可能性
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

非推奨または削除されたバージョン

現在のところ、wp_restore_post_revision 関数は非推奨や削除されたバージョンはありません。

この関数について質問するコメントをキャンセル