About this plugin
An enterprise-ready WordPress plugin that optimizes the content editing experience for headless (decoupled) sites. It handles secure previewing, webhook management, automated CDN cache invalidation, and custom WP-CLI tools.
Key Features
- Settings Panel: A React-powered settings panel built using native WordPress component styling.
- Webhook Triggering: Fires webhook payloads to decoupled frontend when posts are published/modified.
- Revalidation Queue: Uses a queue system (Action Scheduler with standard WP Cron fallback) to send webhooks asynchronously.
- Smart Cache Invalidation: Automatically invalidates cached frontend URLs when related content changes.
- Headless Previews: Directs the classic/Gutenberg preview button to target the frontend API route securely.
- WP-CLI Commands: Automate webhooks, purging, and configuration checks from the command line.
Prerequisites
- Node.js (version specified in.nvmrc)
- Composer (v2)
- PHP 7.4 or later
Local Setup
- Clone the repository into your WordPress plugins folder ( /wp-content/plugins/ ).
- Run npm install to install local JavaScript build tools and dependencies.
- Run composer install to install PHP development tools (PHPUnit, PHPCS).
Build Scripts
- npm run dev or npm run watch: Starts the webpack watcher for React changes, compiling in real-time.
- npm run build: Compiles production-optimized and minified JavaScript/CSS assets.
Testing & Linting
- npm run lint: Runs both JS and PHPCS linters to verify syntax and standard compliance.
- npm run lint:js: Runs WordPress ESLint/Prettier checks on JavaScript code.
- npm run lint:php: Runs PHP CodeSniffer standard checks.
- npm run test: Runs the PHPUnit unit test suite.
External Services
This plugin is designed to connect to external frontend frameworks, content delivery networks (CDNs), or deployment hosting providers (such as Vercel, Netlify, or custom webhook endpoints) to handle cache revalidation and trigger frontend deploys.
Depending on the Webhook URL and Cache Purge Endpoints configured by the administrator in the settings panel:
* Outgoing HTTP POST requests (containing post metadata, URLs to be purged, and cryptographic signatures) will be sent to the user-specified endpoints when posts/pages are published or modified.
* Default/example placeholders reference Vercel. For more details on these integrations, see:
com/legal/terms
com/legal/privacy-policy