README.md

Plugin Skeleton D

---

A WordPress plugin skeleton with modular architecture, first-class tooling, and enterprise-grade best practices - for humans and agentic contributors. Battle-tested and ready to help your team build plugins better, faster, and without compromise.

Documentation

• Development Guide - Local setup, commands, testing, and contribution guidelines.
• Contributing - How to contribute to this project.
• Code of Conduct - Community standards.
• Security - Reporting security vulnerabilities.

Reference: Action Hooks | Filter Hooks | Constants | WP-CLI Commands

Project Structure

├── .github/workflows/      # CI/CD workflows
├── docs/                   # Development guides and references
├── inc/                    # Plugin-specific PHP source
├── framework/              # Reusable framework (shared across plugins)
│   └── README.md
├── src/                    # TypeScript/JS entry points
│   └── README.md
├── templates/              # PHP templates with theme override support
└── tests/                  # PHPUnit, Jest, Playwright tests

See ./docs/DEVELOPMENT.md for a detailed directory tree and descriptions.

Scaffolding a New Plugin

Note

We recommend purging the example modules and blocks once you've understood the structure to keep your production codebase lean.

1. Create a new repo from this template.
2. Find and replace the following placeholder strings:
   • plugin-skeleton-d (slug)
   • Plugin Skeleton D (title)
   • PLUGIN_SKELETON_D (constant prefix)
   • pluginSkeletonD (camelCase reference)
   • PluginSkeletonD (PascalCase reference)
3. Update plugin metadata in these config files:
   • .phpcs.xml.dist (testVersion, minimum_wp_version)
   • composer.json (config.platform.php, require.php)
   • phpstan.neon.dist (phpVersion)
   • plugin-skeleton-d.php
   • readme.txt
4. Remove or replace example entrypoints and blocks from src/, then update webpack.config.js and inc/Core/Assets.php.
5. Update CI workflows in .github/workflows/.
6. Search for @todo comments and resolve them.
7. Remove all remaining example code from inc/, src/, and their corresponding tests/.
8. Update the documentation in docs/ and this README to reflect your plugin's functionality and architecture.

License

GPL-2.0-or-later. See LICENSE.md.