wp-envのローカル環境に本番環境のデータを同期するスクリプト

wp-envはWordPressのローカル環境を簡単にセットアップできるツールです。複雑な構成が不要で、ローカルでWordPressサイトを素早く立ち上げられます。

ローカルのwp-env環境で開発していると、本番環境のデータやコンテンツを同期したいことがよくあります。これまでは手動でデータを反映したりサイト移行プラグインを使って移行したりしていましたが、これらの作業は時間がかかり煩雑でした。

そこで今回、この同期を自動化するスクリプトを作成しました。この記事では、そのスクリプトと使用方法を紹介します。

なお、本記事での説明はmacOSおよびLinux環境を前提としています。

前提条件

このスクリプトの動作にはwp-envが必要です。wp-envのセットアップの方法は公式のリファレンスガイドを参照してください。

このスクリプトではローカルにインストールされたwp-envを使用します。まだプロジェクトにインストールされていない場合は、以下のコマンドでインストールしてください。

npm install --save-dev @wordpress/env

グローバルにインストールしたwp-envを使用する場合は、スクリプトの該当箇所を適宜修正してください。

また、このスクリプトの動作には本番サーバーにSSH接続できる環境も必要です。

SSH接続の設定

本スクリプトはエックスサーバーからのデータ同期を前提として作成されています。エックスサーバーにSSH接続する方法については、以下の記事で詳しく解説しています。

エックスサーバーにSSH接続する｜greencider（グリーンサイダー）

エックスサーバーにSSHで接続する手順を図解付きでわかりやすく解説。公開鍵の生成や登録方法、接続コマンド、エイリアス設定まで実用的な内容をまとめています。

greencd.jp

エックスサーバー以外のサーバーを利用している場合は、スクリプト内のSSH接続設定を環境に合わせて調整してください。

スクリプト

今回作成したスクリプトは以下のGitHubリポジトリで公開しています。

GitHub - foolish-pine/wordpress-sync-production-to-local

Contribute to foolish-pine/wordpress-sync-production-to-local development by creating an account on GitHub.

github.com

このスクリプトは以下の処理を実行します。

1. 本番環境のデータベースをローカルのwp-env環境に同期
2. 本番環境のwp-contentディレクトリをローカルのwp-env環境に同期
3. ローカル環境に合わせてデータを調整

使用方法

このスクリプトは、既存のwp-envを使用しているWordPressプロジェクトで利用できます。

スクリプトを実行すると、ローカルwp-envのデータベースは上書きされます。必要であればスクリプト実行前にバックアップを取得してください。

1. スクリプト（sync-from-production.sh）をプロジェクトのルートディレクトリに配置
2. .wp-env.jsonを設定（後述）
3. リポジトリの.env.exampleを.envにリネームしてプロジェクトルートに設置し、接続情報を設定する（後述）
4. bash sync-from-production.shでスクリプト実行

.wp-env.jsonの設定

スクリプトが正しく動作するよう、プロジェクトルートの.wp-env.jsonに以下の設定を追加します。

1
{
2
  "mappings": {
3
    "wp-content": "./wp-content",
4
    "tmp": "./tmp"
5
  }
6
}

wp-contentとtmpはそれぞれ本番環境からダウンロードしたwp-contentのコンテンツとデータベースのデータを格納するディレクトリです。

ディレクトリ自体はスクリプトの処理中で作成されるので、未作成のままでも問題ありません。既に同名のディレクトリがある場合は、予期せぬファイルの上書きを防ぐため事前にバックアップまたはリネームしてください。

.envファイルの設定

.envファイルでは以下の項目を設定します。

1
# 本番サーバーの接続情報
2
PRODUCTION_USER=sv12345
3
PRODUCTION_HOST=sv12345.xsrv.jp
4
PRODUCTION_SSH_PORT=10022
5
PRODUCTION_SSH_KEY=~/.ssh/xserver
6
PRODUCTION_DIR=/home/sv12345/example.com/public_html
7
PRODUCTION_URL=https://example.com
8

9
# ローカル環境のURL（省略可）
10
LOCAL_URL=http://localhost:8888

各パラメータの説明は以下の通りです。

• PRODUCTION_USER：サーバーのユーザー名
• PRODUCTION_HOST：サーバーのホスト名
• PRODUCTION_SSH_PORT：SSHポート番号（エックスサーバーは10022）
• PRODUCTION_SSH_KEY：SSH秘密鍵のパス
• PRODUCTION_DIR：WordPressがインストールされているディレクトリ
• PRODUCTION_URL：本番サイトのURL
• LOCAL_URL：ローカル環境のURL。省略可能で、省略した場合はhttp://localhost:8888が設定される

スクリプト実行後、http://localhost:8888でローカル環境にアクセスできます。

スクリプトの解説

以下、主要な処理について詳しく解説します。

本番環境のデータベースをローカルのwp-env環境に同期

104
# 本番サーバーからデータベースをエクスポートする
105
dump_production_database() {
106
  log "Connecting to the production server and exporting database..."
107
  ssh $SSH_OPTIONS "$PRODUCTION_USER@$PRODUCTION_HOST" "cd $PRODUCTION_DIR && wp db export --exclude_tables=wp_users dump.sql"
108
  log_success "Database exported on production server"
109
}

142
# ローカル環境にデータベースをインポートする
143
import_database() {
144
  log "Importing database into wp-env..."
145
  run_wp_cli db import /var/www/html/tmp/dump.sql
146
  log_success "Database import completed"
147
}

データベースのエクスポート時に--exclude_tables=wp_usersオプションを使用することで、本番環境のユーザー情報でローカルのユーザー情報を上書きしないようにしています。

本番環境のwp-contentディレクトリをローカルのwp-env環境に同期

121
# 本番サーバーからwp-contentをrsyncで同期する
122
sync_wp_content() {
123
  log "Syncing wp-content from production server..."
124

125
  # 除外パターン
126
  local excludes=(
127
    "uploads/backwpup"
128
  )
129

130
  # 除外オプションを構築
131
  local exclude_opts=()
132
  for pattern in "${excludes[@]}"; do
133
    exclude_opts+=("--exclude=$pattern")
134
  done
135

136
  rsync -av --delete -e "ssh $SSH_OPTIONS" "${exclude_opts[@]}" \
137
    "$PRODUCTION_USER@$PRODUCTION_HOST:$PRODUCTION_DIR/wp-content/" \
138
    "./wp-content"
139
  log_success "wp-content sync completed"
140
}

rsyncを使用して本番環境のwp-contentディレクトリをローカルに同期します。

初回実行時、wp-contentのサイズが大きいと同期が完了するまで時間がかかります。2回目以降は差分の同期のみなので、実行時間は短くなります。

--deleteオプションにより、本番環境に存在しないファイルはローカルからも削除されます。

不要なファイルは除外パターンで除外します。ここではバックアッププラグイン「BackWPup」が作成するバックアップファイルを除外しています。除外パターンはプロジェクトに合わせて適宜変更してください。

ローカル環境に合わせてデータを調整

149
# データベース内のURLを置換する
150
replace_urls() {
151
  log "Replacing URLs in the database..."
152
  run_wp_cli search-replace "$PRODUCTION_URL" "$LOCAL_URL" --precise --recurse-objects --all-tables-with-prefix
153
  log_success "URL replacement completed"
154
}
155

156
# インポートした投稿や固定ページの著者をadminに設定する
157
reassign_post_authors() {
158
  log "Reassigning authors for posts and pages to admin..."
159
  run_wp_cli db query "UPDATE wp_posts SET post_author = (SELECT ID FROM wp_users WHERE user_login = 'admin' LIMIT 1) WHERE post_type IN ('post', 'page');"
160
  log_success "Author reassignment completed"
161
}

179
# 本番環境専用プラグインを無効化
180
disable_production_plugins() {
181
  log "Disabling production-only plugins for local environment..."
182

183
  local plugins_to_disable=(
184
    "cloudsecure-wp-security"
185
  )
186

187
  for plugin in "${plugins_to_disable[@]}"; do
188
    if run_wp_cli plugin is-active "$plugin" 2>/dev/null; then
189
      run_wp_cli plugin deactivate "$plugin"
190
      log_success "$plugin plugin deactivated"
191
    fi
192
  done
193
}

ローカル環境で正しく動作するよう、以下の調整をします。

• URL置換：本番環境のURLをローカル環境のURLに置換
• 著者の再設定：投稿の著者をローカル環境のadminユーザーに設定
• プラグインの無効化：セキュリティプラグインなど本番環境専用のプラグインを無効化

無効化するプラグインはplugins_to_disableで設定しています。プロジェクトに合わせて適宜変更してください。

まとめ

このスクリプトにより、本番環境からローカル環境への同期作業を自動化できました。手動でのデータ移行作業が不要になり、開発効率が大幅に向上します。

必要に応じてスクリプト内の設定を調整して、プロジェクトに合わせてご活用ください。