【2023年】これからブログを始める人へおすすめの書籍

Kissy

【WordPress】wp-env+vscodeでWordPressの開発環境を作る方法

作成: 更新:

【WordPress】wp-env+vscodeでWordPressの開発環境を作る方法

ここでは、wp-envとVisual Studio Code(VSCode)を使ったWordPress開発環境の作り方を記載します。

wp-envはWordPressのローカル環境です。wp-envは以下のような特徴があり、とても簡単に環境を導入できます。

  • dockerファイルを書く必要がない
  • npmコンポーネントとして開発プロジェクトに組み込めるため、プロジェクトをビルドしてすぐに試せる
  • クリーンな状態にリセットできる

準備

・WSL2
・Docker Desktop for Windows
・Node.js
・Visual Studio Code

手順

  1. 任意の場所に作業フォルダを作成し、作成したフォルダに移動する
    mkdir <作業フォルダ名>
    cd <作業フォルダ名>
    
  2. WordPress開発のひな形を作成し、作成されたフォルダに移動する
    ブロック開発の場合
    npx @wordpress/create-block <作成するプラグインの名前>
    cd <作成するプラグインの名前>
    
  3. wp-envを開発環境のみにインストールする
    npm install --save-dev @wordpress/env
    
  4. package.jsonのscriptにwp-envを追加する
    以下をscriptの最後に追加することでnpmからwp-envを実行できるようになる。
    "scripts": {
    	"wp-env": "wp-env"
    },
    
  5. wp-envを起動する
    以下のコマンドを実行すると、dockerでWordPress環境のコンテナが作成される。
    npm run wp-env start
    
  6. WordPressのページが表示されることを確認する
    ブラウザでhttp://localhost:8888にアクセスします。
  7. WordPressの管理画面にアクセスする
    ブラウザでhttp://localhost:8888/wp-adminにアクセスします。
    ユーザー名:admin、パスワード:passwordでログインできます。
  8. VSCodeを起動しプラグインの開発をする
    作業フォルダで以下のコマンドを実行すると、VSCodeが起動します。
    code.
    
  9. プラグインをビルドする
    プラグインに機能を追加して動作を確認したい場合は、以下のコマンドでプラグインをビルドします。ビルドするとすぐにWordPressに反映されます。
    npm run build
    

よく使うコンポーネント

npm install @wordpress/i18n --save
npm install @wordpress/block-editor --save
npm install @wordpress/components --save
npm install @wordpress/compose --save
npm install @wordpress/element --save

よく使うwp-envコマンド

wp-envコマンドはWordPress開発環境を操作するためのコマンドです。以下はよく使うwp-envコマンドです。

開始

WordPress開発環境を起動します。

wp-env start

停止

WordPress開発環境を停止します。

wp-env stop

クリーン

WordPress開発環境を初期状態に戻します。

wp-env clean all

破棄

WordPress開発環境を完全に削除します。

wp-env destroy

エラーの対処方法

「Error while running docker-compose command」

参考サイト

最後まで読んでいただきありがとうございます。
また読んでくださいませ。
そんじゃーね。

関連記事

SPONSORED LINK
SPONSORED LINK