README.md

Sample wp-env Project

A sample project that provides full control and access to all dependencies, debugging and testing without relying on things bundled with the @wordpress/env package.

This might seem verbose but the benefits are clear the first time any changes to the wp-env internals break your development workflow.

• Simplify debugging by adding WordPress core, themes and plugins as Composer depdendencies at locked versions which allows adding Xdebug breakpoints anywhere. By default, wp-env doesn't expose any of these directories.

• Add local project dependencies like plugins and themes as Composer path dependencies and npm workspaces. Easily run linters and build across all sub-projects.

• Enable project-wide PHPUnit testing using a known version of the WordPress PHPUnit testing library (extracted from wordpress-develop repository) instead of what is pulled in by wp-env.

• Enable Xdebug for easy debugging and performance evalutation.

Project Structure

The .wp-env.json config maps the project directories inside the wp-env containers:

├── composer.json
├── composer.lock
├── package-lock.json
├── package.json
├── ...
├── tools (mapped via .wp-env.json from project root)
│   ├── phpcs.xml.dist (project-wide phpcs configuration)
│   ├── phpunit (project-wide PHPUnit tests)
│   │   └── class-project-test.php
│   ├── phpunit-bootstrap.php
│   └── phpunit.xml.dist (project-wide PHPUnit configuration)
├── wordpress (mapped to /var/www/html inside wp-env via .wp-env.json)
│   ├── composer.json (mapped via .wp-env.json from project root)
│   ├── composer.lock (mapped via .wp-env.json from project root)
│   ├── ...
│   ├── tools (mapped via .wp-env.json from project root)
│   ├── ...
│   ├── wp-config.php (created by wp-env)
│   ├── ...
└── wp-content (mapped via .wp-env.json from project root)
    ├── vendor (created by Composer to ensure it is available inside the containers)
    ├── plugins
    │   ├── my-plugin (tracked in the repository)
    │   │   ├── composer.json
    │   │   ├── my-plugin.php
    │   │   ├── package.json
    │   │   ├── php
    │   │   └── tests
    │   └── query-monitor (any plugins added via Composer)
    │       ├── ...
    ├── themes
    │   ├── my-theme (tracked in the repository)
    │   │   ├── composer.json
    │   │   ├── functions.php
    │   │   ├── package.json
    │   │   ├── php
    │   │   ├── style.css
    │   │   ├── tests
    │   │   └── theme.json
    │   └── twentytwentyfive (any themes added via Composer)
    │       ├── ...
    └── uploads
        └── ...

Requirements

Most of these are shared with the @wordpress/env package.

• Docker
• Node.js v20
• PHP 7.4 or later
• Composer

Use a package manager like Homebrew to install these on macOS:

brew install php@7.4 node@20 composer

Setup

Clone this repository to your-project-name directory:

git clone https://github.com/wpelevator/wp-env-example.git your-project-name

Navigate to the your-project-name directory:

cd your-project-name

Install dependencies (which also installs Composer dependencies):

npm install

Start the environment:

npm run start

Visit the URL displayed at the end of the start command above.

Credits

• Created by Kaspars Dambis.
• Licensed under the MIT License.