WordPress Plugin Boilerplate – README
12 Stars
View on GitHub
This boilerplate gives you a structured starting point for building modern WordPress plugins. Use this landing page to choose the workflow you need, understand the moving parts, and jump directly to the relevant guide.
Start Here
Section titled “Start Here”-
Create your plugin from the boilerplate.
Terminal composer create-project juvo/wordpress-plugin-boilerplate -
Start the local WordPress environment.
Terminal npm run env:start -
Pick the guide that matches your next task.
- Building blocks: create-blocks.mdx
- Managing assets: bundeling.mdx
- Running tests: testing.mdx
- Preparing translations: i18n.mdx
Choose Your Path
Section titled “Choose Your Path”Build And Run The Plugin
Section titled “Build And Run The Plugin”| If you want to… | Open this guide |
|---|---|
| start the Docker-based WordPress environment | wp-env.mdx |
| run PHPUnit application tests | testing.mdx |
| understand CI and release automation | github-actions.mdx |
| compile and bundle scripts or styles | bundeling.mdx |
Extend Plugin Features
Section titled “Extend Plugin Features”| If you want to… | Open this guide |
|---|---|
| scaffold and register Gutenberg blocks | create-blocks.mdx |
| register WordPress abilities | abilities.mdx |
| wire in translation extraction and compilation | i18n.mdx |
| expose load hooks for companion plugins | companion-plugins.mdx |
Add Integrations
Section titled “Add Integrations”| If you want to… | Open this guide |
|---|---|
| store ACF field groups in version control | integrations/acf.mdx |
| configure broader ACF integration patterns | integrations/acf.mdx |
| capture runtime errors with Sentry | integrations/sentry.mdx |
Work Effectively With AI And Docs
Section titled “Work Effectively With AI And Docs”| If you want to… | Open this guide |
|---|---|
| understand AI commands, skills, and repo instructions | work-with-ai.mdx |
| keep docs consistent and well-structured | documentation.mdx |
Repo At A Glance
Section titled “Repo At A Glance”- demo-plugin.php Main bootstrap file
Directorysrc/
DirectoryAbilities/ WordPress abilities and categories
- …
DirectoryAPI/ REST API-specific code
- …
DirectoryBlocks/ Gutenberg block implementations
- …
DirectoryCLI/ WP-CLI commands
- …
DirectoryIntegrations/ Third-party and platform integrations
- …
Directoryresources/
Directoryadmin/ Admin-side scripts and styles
- …
Directoryfrontend/ Frontend scripts and styles
- …
Directorytests/
Directoryphp/ PHPUnit application tests
- …
Directorydocs/ This documentation site
- …
What The Boilerplate Optimizes For
Section titled “What The Boilerplate Optimizes For”- clear separation between bootstrap code, plugin logic, assets, docs, and tests
- reproducible local development with
wp-env - production-ready quality gates for PHP, JavaScript, styles, and application tests
- documented extension points for blocks, abilities, translations, and integrations
- AI-friendly project instructions without replacing human-readable docs
Looking For The Repository Overview?
Section titled “Looking For The Repository Overview?”The root README.md in the source repository is the developer-oriented repo introduction. It is the best place to understand the repository layout, command surface, AI instructions, and maintenance expectations.