ローカルの Docker ベース Staging サイトを作成するためのツール、WP STAGING CLI をお探しですか?代わりにこちらをご覧ください。
WP STAGING Plugin は、WordPress サイト用の Staging 環境作成や高性能な Backup のための強力なツールです。本番サイトに影響を与えずに、変更を加えたり、新機能をテストしたり、更新を実行したりできます。本ドキュメントでは、WP STAGING Plugin 専用に設計された WP CLI コマンドの使用方法を説明します。
Contents
前提条件
WP STAGING | PRO Plugin 用の WP CLI コマンドを使用する前に、以下の要件が満たされていることを確認してください:
- WordPress インストール: サーバーに WordPress がインストールされていることを確認してください。
- WP CLI: サーバーに WP CLI (WordPress 用コマンドラインインターフェイス) がインストールされていることを確認してください。WP-CLI インストール手順をお読みください。
WP CLI 経由で通常の Backup を作成する
wp wpstg backup-create コマンドを使うと、WordPress 環境の Backup を作成できます。この Backup により、テストや更新中に問題が発生した場合に以前の状態に戻せます。
構文
# Regular Syntax
wp wpstg backup-create
# Run WP Cli as sudo
sudo -u myuser -- /usr/local/bin/wp --path='/home/example.com/public_html/' --url='example.com' wpstg backup-create使用できるパラメータがいくつかあります:
name
デフォルト値: null
説明: Backup ファイル名。サポートされる入力型は文字列。
使用例:
wp wpstg backup-create name=my-backup
# or
wp wpstg backup-create name='backup name with spaces'includes
デフォルト値: database, mu-plugins, plugins, themes, uploads, others
説明: Backup に含めるパーツ。サポートされる値は database、mu-plugins、plugins、themes、uploads、others です。
複数値もサポートされています。database,plugins,uploads のようにカンマで複数値を追加できます。
includes または excludes パラメータのいずれか一方のみを使用してください。両方が使用された場合、includes パラメータが優先され、excludes パラメータは無視されます。
使用例:
wp wpstg backup-create includes=plugins,themes
# or
wp wpstg backup-create includes=databaseexcludes
デフォルト値: null
説明: Backup から除外するパーツ。サポートされる値は database、mu-plugins、plugins、themes、uploads、others です。複数値もサポートされています。database,plugins,uploads のようにカンマで複数値を追加できます。includes または excludes のいずれかのパラメータのみが使用されます。コマンドで両方が使用された場合、includes パラメータが優先され、excludes パラメータは無視されます。
使用例:
wp wpstg backup-create excludes=database
# or
wp wpstg backup-create excludes=plugins,mu-pluginsadvanced-excludes
デフォルト値: null
説明: Backup から除外する追加のパーツ。
サポートされる値: logs, caches, deactivated-plugins, unused-themes, post-revisions, spam-comments
使用例:
wp wpstg backup-create advanced-excludes=logs,caches,deactivated-plugin,unused-themes,post-revisions,spam-comments
storages
デフォルト値: local-storage
説明: Backup の保存・アップロード先となるストレージ。よくサポートされる値は local-storage、google-drive、amazon-s3、dropbox、sftp です。
複数値もサポートされています。google-drive,amazon-s3,sftp のようにカンマで複数値を追加できます。使用したいストレージは事前に WordPress 管理画面で認証されていることを確認してください。
使用例:
wp wpstg backup-create storages=google-drive
# or
wp wpstg backup-create storages=local-storage,sftpWP CLI 経由でスケジュール Backup プランを作成する
WP CLI を使ってスケジュール Backup プランを作成できます:
schedule
デフォルト値: null
説明: Backup を繰り返す頻度。サポートされる値: hourly、every-six-hours、every-twelve-hours、daily、every-two-days、weekly、every-two-weeks、monthly。一度に 1 つの値のみサポートされます。値が設定されていない場合、Backup はスケジュールされません。
使用例:
wp wpstg backup-create schedule=hourly
# or
wp wpstg backup-create schedule=monthlyretention
デフォルト値: 2
説明: このスケジュールで保持する Backup の数。サポートされる値: 1 から 10。null 以外の有効な schedule 値が必要で、そうでない場合このオプションは無視されます。
使用例:
wp wpstg backup-create schedule=monthly retention=3
# or
wp wpstg backup-create schedule=monthly retention=5time
デフォルト値: 00:00
説明: Backup を最初にスケジュール開始する時刻。サポートされる値は 24 時間形式の時刻で、13:00、05:42、23:59、00:00、10:45 など。now を使用して、現在時刻を最初の繰り返し時刻として即座に Backup を作成することもできます。null 以外の有効な schedule 値が必要で、そうでない場合このオプションは無視されます。
使用例:
wp wpstg backup-create schedule=daily time='00:15'
# or
wp wpstg backup-create schedule=monthly time='12:12'
# or
wp wpstg backup-create schedule=monthly time='now'WP CLI で実行中の Backup ステータスを表示する
wp wpstg backup-status コマンドは、WordPress 環境で実行中の Backup のステータスと詳細を表示します。Backup ID、タイトル、作成日、説明などの情報を提供します。
構文
wp wpstg backup-status結論
WP STAGING Plugin と提供される WP CLI コマンドは、Staging 環境で Backup を管理しステータスを監視する便利な方法を提供します。本ドキュメントに記載された手順に従うことで、Backup を効果的に作成し、WordPress サイト内で利用可能な Backup について常に把握できます。
