`wp-env`

Quick (tl;dr) instructions

Prerequisites

Experimental: WordPress Playground Runtime

Playground vs Docker

Installation

Installation as a global package

Installation as a local package

Usage

Starting the environment

Stopping the environment

Troubleshooting common problems

1. Check that `wp-env` is running

2. Check the port number

3. Restart `wp-env` with updates

4. Restart Docker

5. Reset the database

6. Destroy everything and start again 🔥

Using included WordPress PHPUnit test files

Customizing the `wp-tests-config.php` file

Using `composer`, `phpunit`, and `wp-cli` tools.

Using Xdebug

Xdebug IDE support

Command reference

Global options

Running parallel environments

`wp-env start`

`wp-env stop`

`wp-env reset [environment]`

`wp-env run [command...]`

Displaying the users on the development instance:

Creating a post on the development instance:

Opening the WordPress shell and running PHP commands:

Installing a plugin or theme on the development instance

Changing the permalink structure

`wp-env cleanup`

`wp-env destroy`

`wp-env logs [environment]`

`wp-env status`

.wp-env.json

Automatic Port Selection

.wp-env.override.json

Default wp-config values.

Lifecycle Scripts

Examples

Latest stable WordPress + current directory as a plugin

Latest development WordPress + current directory as a plugin

Local `wordpress-develop` + current directory as a plugin

A complete testing environment

Add mu-plugins and other mapped directories

Avoid activating plugins or themes on the instance

Map a plugin only in a specific environment

Custom Port Numbers

Specific PHP Version

Multisite support

Node Lifecycle Script

Advanced PHP settings

Using SPX Profiling

Contributing to this package