It looks like you're new here. If you want to get involved, click one of these buttons!Sign In Register
It looks like you're new here. If you want to get involved, click one of these buttons!
Welcome to the WordPress development repository! Please check out the contributor handbook for information about how to open bug reports, contribute patches, test changes, write documentation, or get involved in any way you can.
To get started, create a codespace for this repository by clicking this 👇
A codespace will open in a web-based version of Visual Studio Code. The dev container is fully configured with softwares needed for this project.
In some browsers the keyboard shortcut for opening the command palette (Ctrl/Command + Shift + P) may collide with a browser shortcut. The command palette can be opened via the
F1 key or via the cog icon in the bottom left of the editor.
When opening your codespace, be sure to wait for the
postCreateCommand to finish running to ensure your WordPress install is successfully set up. This can take a few minutes.
You will need a basic understanding of how to use the command line on your computer. This will allow you to set up the local development environment, to start it and stop it when necessary, and to run the tests.
brew install node
choco install nodejs
apt install nodejs npm
If you are not using a package manager, see the Node.js download page for installers and binaries.
Note: WordPress currently only supports Node.js
14.x and npm
You will also need Docker installed and running on your computer. Docker is the virtualization software that powers the local development environment. Docker can be installed just like any other regular application.
Ensure Docker is running before using these commands.
Clone the current repository using
git clone https://github.com/WordPress/wordpress-develop.git. Then in your terminal move to the repository folder
cd wordpress-develop and run the following commands:
npm install npm run build:dev npm run env:start npm run env:install
Your WordPress site will be accessible at http://localhost:8889. You can see or change configurations in the
.env file located at the root of the project directory.
If you're making changes to WordPress core files, you should start the file watcher in order to build or copy the files as necessary:
npm run dev
To stop the watcher, press
npm run env:cli -- <command>
WP-CLI has many useful commands you can use to work on your WordPress site. Where the documentation mentions running
npm run env:cli -- instead. For example:
npm run env:cli -- help
These commands run the PHP and end-to-end test suites, respectively:
npm run test:php npm run test:e2e
You may want to restart the environment if you've made changes to the configuration in the
.env files. Restart the environment with:
npm run env:restart
You can stop the environment when you're not using it to preserve your computer's power and resources:
npm run env:stop
Starting the environment again is a single command:
npm run env:start
These are the default environment credentials:
To login to the site, navigate to http://localhost:8889/wp-admin.
Note: With Codespaces, open the portforwarded URL from the ports tab in the terminal, and append
/wp-admin to login to the site.
To generate a new password (recommended):