WordPressプラグイン開発記 vol.1 – DockerでWordPressローカル環境を構築する

このサイトはアフィリエイト広告(Amazonアソシエイト含む)を掲載しています。
ノートパソコンにWordPressの管理画面を描いたイラスト

このブログはWordPressで構成していますが、運用しているとやっぱりあんなことしたい、こんなことしたいが出てきます。公開されているプラグインで事足る場合もありますが、自分がやりたいことと少し違うんだなー・・・がぼちぼちあったりします。

ということで、いろいろやりたいことをまとめた自分用プラグインを作ってみることにしました。PHPはともかくWordPressのカスタマイスはどどどどど素人なので不安しかありませんが

自作プラグインを試せるようにまずはWindowsのDocker DesktopでWordPressのローカル環境を用意します。今回はWordPress・MariaDB・phpMyAdminを起動しブラウザから開ける状態にするところまで進めます。プラグイン用のPHPファイルを作成する手順は次回です。

目次

なぜプラグイン?

特に理由はありません!

いえ、ちょっとだけあります・・・DBにデータを保存する予定なので、必要なテーブルを作る処理やプラグインを削除したときの後片付けをまとめて管理できるとすっきりしそうです。無効化は一時的に使わなくする操作なので、保存したデータは残し、不要になったデータを削除する処理はアンインストール時に分けます。どうせ実装するなら最初からプラグイン形式でやってみようという感じです。

PCにWordPressのローカル環境を準備する

こうなると開発環境が必要になりますね。簡単に構築する方法としてLocalWPを使う方法もあるようですが、どうやらDocker HubにWordPressの公式イメージがあるようなので今回はDockerで構築したいと思います。

Docker本体の準備

Dockerを利用するにはPCにDocker Desktopが必要です。筆者のPCにはすでにインストールしているのでココはskipしちゃいます。


Dockerを使う理由やコンテナ・イメージ・Docker Composeの関係を先に整理したい場合は次の記事で確認できます。

docker-compose.yamlを準備する

記事作成時点でこのWordPressが動いている環境と合わせて以下のバージョンで準備します。PhpMyAdminはDBが見れればいいので最新版を使うことにします。

以下は、この環境を構築したときの構成です。

  • WordPress 6.9.4
  • PHP 8.5
  • MariaDB 10.5
  • phpMyAdminはlatestタグを使用

MariaDB 10.5はCommunity版の保守が終了しています。ここでは当時の構成を記録していますが、新しく環境を作る場合は保守中のバージョンでWordPressや自作プラグインの動作を確認してください。掲載したバージョンの組み合わせは現在の推奨構成を示すものではありません。

PC上にプロジェクトを作成するフォルダーの場所を決めて、そこにdocker-compose.yamlというファイルを作成します。今回はD:\wordpressにフォルダーを準備しました。このファイルに下記を記載していきます。

以降「コンテナ」という言葉が出てきますが、PC内に別の独立したマシンを立ち上げるようなイメージで読んでもらえると分かりやすいと思います。

共通の記載

まずファイル全体の骨格となる部分から書いていきます。

docker-compose.yaml
services:
  # WordPressコンテナの記載

  # MySQL(MariaDB)コンテナの記載

  # phpMyAdminコンテナの記載

networks:
  wp-network:
    driver: bridge

volumes:
  db_data:
services

これから動かすコンテナ(サービス)達を定義するよ、という宣言です。docker-compose.yamlの先頭に必要な記載だという風に思ってもらっていいと思います。

networks → wp-network → driver: bridge

wp-networkという名前でコンテナ間で通信できるようにする一般的な「ブリッジ」という形式のネットワークを作成します。

volumes → db_data

共通というよりどちらかといえばMySQL(MariaDB)の設定に近いですが、コンテナの外側にある記載なのでここにまとめました。db_dataという名前でDockerが管理する領域にデータを保管するように指定しています。いわゆるデータ永続化です。

Webサーバー + PHP + WordPress

Docker Hub公式のWordPressイメージを指定してWordPressのコンテナを作成する記載です。これによってApache+ PHP + WordPressが1つのコンテナ内に構成されます。

docker-compose.yaml – # WordPressコンテナの記載
  wordpress:
    image: wordpress:6.9.4-php8.5-apache
    container_name: wp
    depends_on:
      - db
    ports:
      - "127.0.0.1:80:80"
    restart: always
    environment:
      WORDPRESS_DB_HOST: db:3306
      WORDPRESS_DB_USER: 【DBユーザー名】
      WORDPRESS_DB_PASSWORD: 【DBパスワード】
      WORDPRESS_DB_NAME: 【DB名】
    volumes:
      - ./wordpress_files:/var/www/html
    networks:
      - wp-network
wordpress

サービス名です。自由に命名して大丈夫です。

image

Docker Hub公式のWordPressイメージのタグページでインストールしたい構成、バージョンを探します。そこにあるdocker pull wordpress:********のdocker pull以降を指定します。

container_name

コンテナ名です。自由に命名して大丈夫です。指定しないと自動で名前がつきます。

depends_on

dbサービスのコンテナを先に起動します。MariaDBの接続準備が整うまでは待ちません。

ports

127.0.0.1:80:80はPCのループバックアドレスの80番ポートをWordPressコンテナの80番ポートにつなぐ指定です。開発用PCでhttp://localhost/を開いてアクセスします。

restart

alwaysはコンテナの終了時やDockerの起動時に自動で再起動する設定です。手動で停止した場合はそのコンテナを手動で起動するかDockerを再起動するまで停止したままになります。

environment

DBに接続するための設定です。WORDPRESS_DB_HOSTには後ほど設定するMySQL側のサービス名:MySQL側のポート番号を指定します。【DBユーザー名】、【DBパスワード】、【DB名】についてもMySQL側で設定した値を指定してください。

volumes

./wordpress_files:/var/www/htmlはdocker-compose.yamlを置いたフォルダー内のwordpress_filesをコンテナの/var/www/htmlとして使う設定です。PC側とコンテナ側から同じファイルを参照するためPC側で編集したPHPファイルをWordPressで読み込めます。

networks

共通の記載のnetworksで設定したネットワークに参加します。コンテナ(ここではWordPressとMySQL(MariaDB)とphpMyAdmin)は別マシンみたいな形になりますが、すべてに同じネットワークを指定することで簡単にコンテナ間でやり取りできるようになるのがDockerの便利なところですね!

volumesのコンテナ内パス(/var/www/html)は公式イメージの仕様に依存するため変更しないほうが無難です。PC側のフォルダー名は自由に変更できます。


Windows環境でこのようにWordPress一式をbind mountするとファイルアクセスがボトルネックになる場合があります。表示が極端に遅いときの切り分けと、named volumeへ移行する手順は次の記事で確認できます。

MySQL(MariaDB)

Docker Hub公式のMariaDBイメージを使います。WordPressが実際にデータを読み書きするDBのコンテナです。

docker-compose.yaml – # MySQL(MariaDB)コンテナの記載
  db:
    image: mariadb:10.5
    container_name: wp-mariadb
    restart: always
    environment:
      MARIADB_ROOT_PASSWORD: 【管理者パスワード】
      MARIADB_DATABASE: 【DB名】
      MARIADB_USER: 【DBユーザー名】
      MARIADB_PASSWORD: 【DBパスワード】
    volumes:
      - db_data:/var/lib/mysql
    networks:
      - wp-network
db

サービス名です。他のコンテナからこの名前でアクセスできます。

image

MariaDBのバージョン10.5の公式イメージを使用します。

container_name

コンテナ名を指定します。指定しない場合自動で名前がつきます。

restart

alwaysはコンテナの終了時やDockerの起動時に自動で再起動する設定です。手動で停止した場合はそのコンテナを手動で起動するかDockerを再起動するまで停止したままになります。

environment

コンテナ内の環境変数(設定値)です。

  • MARIADB_ROOT_PASSWORD: 管理者(root)のパスワード。
  • MARIADB_DATABASE: 初回起動時に作成されるデータベース名。
  • MARIADB_USER: WordPressが利用する一般ユーザー名。
  • MARIADB_PASSWORD: WordPressが利用する一般ユーザーのパスワード。
volumes

db_data:/var/lib/mysqlでコンテナ内のDBデータをDockerが管理する領域(コンテナの外側)に保存するようにします。

networks

wordpressのサービスと同じネットワークを設定します。

db_dataはDBデータを保存する名前付きボリュームです。この構成ではコンテナを削除してもボリュームを残していればDBデータを再利用できます。docker compose down -vはdb_dataも削除するため通常の停止には使わないでください。

MARIADB_DATABASE・MARIADB_USER・MARIADB_PASSWORD・MARIADB_ROOT_PASSWORDは、DBを初めて作成するときの設定です。すでにdb_dataへDBが作られている場合、YAMLを書き換えて再起動するだけでは作成済みのユーザーやパスワードは変更されません。

phpMyAdmin

Docker Hub公式のphpMyAdminイメージを指定してphpMyAdminのコンテナを作成する記載です。

docker-compose.yaml – # phpMyAdminコンテナの記載
  phpmyadmin:
    image: phpmyadmin
    container_name: wp-phpmyadmin
    ports:
      - "127.0.0.1:8080:80"
    environment:
      PMA_HOST: db
      PMA_PORT: 3306
    depends_on:
      - db
    networks:
      - wp-network
phpmyadmin

サービス名です。

image

タグを省略しているためphpmyadmin:latestを指定した扱いになります。起動のたびに最新版へ自動更新されるという意味ではありません。

container_name

コンテナ名を指定します。指定しない場合自動で名前がつきます。

ports

127.0.0.1:8080:80はPCのループバックアドレスの8080番ポートをphpMyAdminコンテナの80番ポートにつなぐ指定です。開発用PCでhttp://localhost:8080/を開いてアクセスします。

environment
  • PMA_HOST: Mysql(MariaDB)のサービス名のdbを指定します。
  • PMA_PORT: 同上のポート番号を指定します。
depends_on

dbサービスのコンテナを先に起動してからphpmyadminサービスを起動します。MariaDBの接続準備が整うまで待つ指定ではありません。

networks

wordpressのサービスと同じネットワークを設定します。

dockerのコマンドを実行してコンテナを起動する

docker-compose.yamlを分割して説明していたので、ひとまずフルバージョンを載せておきます。【】 部分をご自身の設定値に置き換えてそのまま使えます。

docker-compose.yaml – フルバージョン
docker-compose.yaml – フルバージョン
services:
  wordpress:
    image: wordpress:6.9.4-php8.5-apache
    container_name: wp
    depends_on:
      - db
    ports:
      - "127.0.0.1:80:80"
    restart: always
    environment:
      WORDPRESS_DB_HOST: db:3306
      WORDPRESS_DB_USER: 【DBユーザー名】
      WORDPRESS_DB_PASSWORD: 【DBパスワード】
      WORDPRESS_DB_NAME: 【DB名】
    volumes:
      - ./wordpress_files:/var/www/html
    networks:
      - wp-network

  db:
    image: mariadb:10.5
    container_name: wp-mariadb
    restart: always
    environment:
      MARIADB_ROOT_PASSWORD: 【管理者パスワード】
      MARIADB_DATABASE: 【DB名】
      MARIADB_USER: 【DBユーザー名】
      MARIADB_PASSWORD: 【DBパスワード】
    volumes:
      - db_data:/var/lib/mysql
    networks:
      - wp-network

  phpmyadmin:
    image: phpmyadmin
    container_name: wp-phpmyadmin
    ports:
      - "127.0.0.1:8080:80"
    environment:
      PMA_HOST: db
      PMA_PORT: 3306
    depends_on:
      - db
    networks:
      - wp-network

networks:
  wp-network:
    driver: bridge

volumes:
  db_data:

PowerShellまたはコマンドプロンプトでdocker-compose.yamlがあるフォルダー(今回はD:\wordpress)に移動して以下のコマンドを実行します。

コマンド
docker compose up -d
コマンド – 実行結果
[+] up 45/45
 ✔ Image wordpress:6.9.4-php8.5-apache Pulled                                            22.4s
 ✔ Image mariadb:10.5                  Pulled                                            19.9s
 ✔ Image phpmyadmin:latest             Pulled                                            20.7s
 ✔ Network wordpress_wp-network        Created                                           0.0s
 ✔ Volume wordpress_db_data            Created                                           0.0s
 ✔ Container wp-mariadb                Started                                           0.8s
 ✔ Container wp                        Started                                           0.5s
 ✔ Container wp-phpmyadmin             Started                                           0.5s

Docker Desktopのコンテナの画面でこんな感じで動いているのが確認できますね。

Docker Desktopでwp・wp-mariadb・wp-phpmyadminの3つのコンテナが起動している画面
構築時のDocker Desktop画面。緑の状態表示で3つのコンテナが起動していることを確認できます。

これで下記でアクセスするとローカルで動作する環境にアクセス可能です。

  • http://localhost/ → WordPress
  • http://localhost:8080/ → phpMyAdmin

初回アクセス時はWordPressのインストール画面が表示されます。言語やサイト名・管理者アカウントを設定すればローカルのWordPressが使える状態になりますよ。

phpMyAdminにはMARIADB_USERとMARIADB_PASSWORDに設定したDBユーザー名・パスワードでログインします。

また、WordPressを構成するファイルはプロジェクトフォルダー直下のwordpress_filesに作成されています。(volumes:で./wordpress_filesと指定しているので。)今回の例だとD:\wordpress\wordpress_filesですね。

この中にプラグインを作っていくことになります。例えばwp-content/plugins/my-plugin/my-plugin.phpのような感じですね。


phpMyAdminでDBを確認する例として投稿の自動保存とリビジョンを調べてみると保存の仕組みが分かります。確認用のSQLと編集・保存したときの変化は以下の記事で説明しています。

開発環境を停止・再開する

作業を終えたらdocker-compose.yamlのあるフォルダーで次のコマンドを実行します。コンテナを停止し、WordPressのファイルとDBデータは残します。

PowerShell
docker compose stop

次回はDocker Desktopを起動してから同じフォルダーで次のコマンドを実行すると、停止したコンテナを再開できます。

PowerShell
docker compose start

WindowsのDocker Desktopでコンテナが応答せず停止操作も失敗したときはDockerが認識しているメモリ容量を確認してみてください。WSL2のメモリ上限を調べた事例を別記事にまとめています。



自作プラグインの続きだけでなくWordPress本体の新機能や運用・セキュリティの記事もまとめページから探せます。

  • URLをコピーしました!
目次