You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Robert Anderson bea15ce1a8 Editor: Update packages 3 months ago
.github Build/Test Tools: Avoid logging the same debug info twice in the PHPUnit workflow. 3 months ago
src Editor: Update packages 3 months ago
tests Taxonomy: Revert Light-weight/partial term counts. 3 months ago
tools Build/Test Tools: Allow the desired version of PHPUnit to be passed to the local Docker environment. 3 months ago
.editorconfig General: Instruct file editors not to trim trailing whitespace in markdown files. 2 years ago
.env Build/Test Tools: Allow the desired version of PHPUnit to be passed to the local Docker environment. 3 months ago
.eslintignore Build/Test Tools: Enable JSDocs to be linted with ESLint. 7 months ago
.eslintrc-jsdoc.js Build/Test Tools: Enable JSDocs to be linted with ESLint. 7 months ago
.gitignore Bundled Themes: Import Twenty Twenty-One, the new default theme for WordPress 5.6. 4 months ago
.jshintrc Build tools: Fix the `travis:js` build. 2 years ago
.npmrc Once upon a midnight dreary, while I coded, weak and weary, 2 years ago
.nvmrc Once upon a midnight dreary, while I coded, weak and weary, 2 years ago
.travis.yml Build/Test Tools: Allow the desired version of PHPUnit to be passed to the local Docker environment. 3 months ago
Gruntfile.js REST API: Introduce Application Passwords for API authentication. 4 months ago
README.md Build/Test Tools: Further enhancements to the local development environment readme. 9 months ago
SECURITY.md Trunk is now 5.6 alpha. 7 months ago
appveyor.yml Build/Test Tools: Remove the dependency on a globally installed Grunt. 1 year ago
composer.json Build Tools: Fix running installing composer dependencies using composer 2.0. 4 months ago
composer.lock Build Tools: Fix running installing composer dependencies using composer 2.0. 4 months ago
docker-compose.yml Build/Test Tools: Allow the desired version of PHPUnit to be passed to the local Docker environment. 3 months ago
jsdoc.conf.json Build Tools: Fix JSDoc configuration include paths. 2 years ago
package-lock.json Editor: Update packages 3 months ago
package.json Editor: Update packages 3 months ago
phpcompat.xml.dist General: Continuing to work towards a passing PHP Compatibility scan. 8 months ago
phpcs.xml.dist Tests: Backport two changes from PHPUnit 9.3: 5 months ago
phpunit.xml.dist Build/Test Tools: Update code coverage setup in the `phpunit.xml.dist` file to point to the `build` directory. 6 months ago
webpack.config.js Build tools: Allow building WordPress to `src`. 2 years ago
wp-cli.yml Build/Tests: Default to running unit tests from `src`. 2 years ago
wp-config-sample.php Code Modernization: Replace `dirname( __FILE__ )` calls with `__DIR__` magic constant. 1 year ago
wp-tests-config-sample.php Tests: Revert the `dirname( __FILE__ )` replacement in `wp-tests-config-sample.php` for now, to avoid breaking unit tests created with WP-CLI `scaffold` command. 1 year ago

README.md

WordPress

Build Status

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.

Getting Started

WordPress is a PHP, MySQL, and JavaScript based project, and uses Node for its JavaScript dependencies. A local development environment is available to quickly get up and running.

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.

You will need Node and npm installed on your computer. Node is a JavaScript runtime used for developer tooling, and npm is the package manager included with Node. If you have a package manager installed for your operating system, setup can be as straightforward as:

  • macOS: brew install node
  • Windows: choco install node
  • Ubuntu: apt install nodejs npm

If you are not using a package manager, see the Node.js download page for installers and binaries.

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.

Development Environment Commands

Ensure Docker is running before using these commands.

To start the development environment for the first time

npm install
npm run build:dev
npm run env:start
npm run env:install

Your WordPress site will accessible at http://localhost:8889. You can see or change configurations in the .env file located at the root of the project directory.

To watch for changes

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 watch

To stop the watcher, press ctrl+c.

To run a WP-CLI command

npm run env:cli <command>

WP-CLI has a lot of useful commands you can use to work on your WordPress site. Where the documentation mentions running wp, run npm run env:cli instead. For example:

npm run env:cli help

To run the tests

These commands run the PHP and end-to-end test suites, respectively:

npm run test:php
npm run test:e2e

To restart the development environment

You may want to restart the environment if you've made changes to the configuration in the docker-compose.yml or .env files. Restart the environment with:

npm run env:restart

To stop the development environment

You can stop the environment when you're not using it to preserve your computer's power and resources:

npm run env:stop

To start the development environment again

Starting the environment again is a single command:

npm run env:start

Credentials

These are the default environment credentials:

  • Database Name: wordpress_develop
  • Username: root
  • Password: password

To login to the site, navigate to http://localhost:8889/wp-admin.

  • Username: admin
  • Password: password

To generate a new password (recommended):

  1. Go to the Dashboard
  2. Click the Users menu on the left
  3. Click the Edit link below the admin user
  4. Scroll down and click 'Generate password'. Either use this password (recommended) or change it, then click 'Update User'. If you use the generated password be sure to save it somewhere (password manager, etc).