WordPress Skeleton Application

Welcome to WordPress! This repository is a starting point for building your WordPress application, including all the base directories.

Directories

The docs/ directory is a special directory that contains your documentation for your application. It is not mounted onto your site, but is available for you to use. See docs/index.php for more information.

Local environment and CI

Development happens in Local; wp-env (Docker) is for running the test suites, in CI and optionally on your machine.

• pnpm install at the repo root installs @wordpress/env. pnpm env:start / pnpm env:stop start and stop it, and pnpm wp <command> runs WP-CLI in it.
• .wp-env.json mounts themes/, plugins/ and mu-plugins/, and activates the first theme in themes/ after start (set WP_THEME to pick another).
• Plugins come from WP Packagist: composer require wpackagist-plugin/<slug>. They install into plugins/ and are gitignored; our own plugins are tracked by their tk- prefix (change !/plugins/tk-*/ in .gitignore to match your project's prefix). mu-plugins/ is not ignored. Run composer install before pnpm env:start so wp-env loads them.
• .github/workflows/tests.yml runs PHPCS on the whole repo and, for every theme in themes/ that has a package.json, its JS unit, PHPUnit, E2E and accessibility suites.

Your documentation here

Feel free to add to or replace this README.md content with content unique to your project, for example:

• Project-specific notes; like a list of environments and branches,
• Workflow documentation; so everyone working in this repo can follow a defined process, or
• Instructions for testing new features.

This can be detailed in the docs/ directory.