Go to file
Sergey Biryukov b54d5925ce Docs: Improve documentation for `WP_REST_Attachments_Controller`.
This adds a missing DocBlock for `::register_routes()` and parameter descriptions for `::post_process_item()`.

Includes minor documenation fixes in other REST API classes for consistency.

Props dkarfa, mukesh27, SergeyBiryukov.
Fixes #48841.

git-svn-id: https://develop.svn.wordpress.org/trunk@47391 602fd350-edb4-49c9-b593-d223f7449a82
2020-02-28 12:29:53 +00:00
.github General: Introduce a pull request template. 2020-02-21 18:23:28 +00:00
src Docs: Improve documentation for `WP_REST_Attachments_Controller`. 2020-02-28 12:29:53 +00:00
tests Build/Test Tools: Remove redundant `Tests_Post_Types::register_post_type()` helper method, use `register_post_type()` directly. 2020-02-26 13:16:10 +00:00
tools Build Tools: 2020-02-24 21:20:49 +00:00
.editorconfig
.env Docs: Fix typo in `.env` file description. 2019-12-30 13:46:17 +00:00
.gitignore Build Tools: 2020-02-24 21:20:49 +00:00
.jshintrc Build tools: Fix the `travis:js` build. 2018-12-24 13:53:11 +00:00
.npmrc
.nvmrc
.travis.yml Build/Test Tools: Don't hardcode the directory name of the repo 2019-10-28 04:15:37 +00:00
Gruntfile.js Build Tools: Do not delete the (now committed) `script-loader-packages.php` file when running `clean:js` and copy it to /build. Fixes cases when running `grunt watch` or `-dev` where that file may be deleted and not recreated. 2020-02-26 05:13:05 +00:00
README.md Docs: Fix typo in `README.md`. 2019-11-20 08:31:32 +00:00
SECURITY.md Security: Add WordPress 5.3.x to the "Supported Versions" section of GitHub Security Policy. 2019-11-16 11:17:42 +00:00
appveyor.yml Build/Test Tools: Remove the dependency on a globally installed Grunt. 2019-05-26 19:34:24 +00:00
composer.json Coding Standards: Update PHPCS Composer plugin to v0.6.0. 2020-02-28 01:38:58 +00:00
composer.lock Build/Test Tools: Introduce automated PHP compatibility checking. 2019-09-25 13:46:55 +00:00
docker-compose.yml Build/Test Tools: Expose port 3306 of MySQL container. 2020-02-09 21:20:25 +00:00
jsdoc.conf.json
package-lock.json Block Editor: Update WordPress Packages WordPress 5.4 Beta 3. 2020-02-25 00:16:12 +00:00
package.json Block Editor: Update WordPress Packages WordPress 5.4 Beta 3. 2020-02-25 00:16:12 +00:00
phpcompat.xml.dist Docs: Improve inline comments per the documentation standards. 2020-01-29 00:43:23 +00:00
phpcs.xml.dist Coding Standards: Adjust coding standards to always omit parentheses for `include`/`require` statements. 2020-02-07 19:14:29 +00:00
phpunit.xml.dist Docs: Improve inline comments per the documentation standards. 2020-01-29 00:43:23 +00:00
webpack.config.js
wp-cli.yml Build/Tests: Default to running unit tests from `src`. 2019-01-09 10:09:02 +00:00
wp-config-sample.php Code Modernization: Replace `dirname( __FILE__ )` calls with `__DIR__` magic constant. 2020-02-06 06:31:22 +00:00
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. 2020-02-06 21:49:13 +00:00

README.md

WordPress

Build Status

Welcome to the WordPress development repository! Please check out our contributor handbook for information about how to open bug reports, contribute patches, test, documentation, or get involved in any way you can.

Getting Started

WordPress is a PHP/MySQL-based project. We have a basic development environment that you can quickly get up and running with a few commands. First off, you will need to download and install Docker, if you don't have it already. After that, there are a few commands to run:

Development Environment Commands

Running these commands will start the development environment:

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

Additionally, npm run env:stop will stop the environment.

npm run env:cli runs the WP-CLI tool. 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.

npm run test:php and npm run test:e2e run the PHP and E2E test suites, respectively.