From 41ad723a6cfe3d831efe5af2565893d7748155fc Mon Sep 17 00:00:00 2001 From: Gareth Bissland <5170216+gbissland@users.noreply.github.com> Date: Fri, 28 Feb 2025 06:47:39 +1300 Subject: [PATCH] Update README.md Updated for WP-Umbrella --- README.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c73cf69..c011f54 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # Weave Cache Purge Helper -This is a fork of the Cache Purge Helper plugin, tailored for use by Weave Digital. It includes additional hooks for Beaver Builder and ACF to trigger NGINX Helper and LiteSpeed Cache plugin purges. +This is a fork of the Cache Purge Helper plugin, tailored for use by Weave Digital on GridPane. It includes additional hooks for Beaver Builder, ACF, and WP-Umbrella to trigger NGINX Helper and LiteSpeed Cache plugin purges. ## Changes from Original Plugin ### Added -- Integration ACF Options pages update to trigger cache purges. +- Integration with ACF Options pages updates to trigger cache purges. +- Integration with WP-Umbrella to ensure proper cache clearing after plugin updates. +- Proper cache clearing sequence (Beaver Builder first, then Nginx/LiteSpeed) to prevent 404 errors. ### Changed - Logging prefix updated from `cphp` to `wcph`. @@ -23,12 +25,20 @@ This fork is based on the Cache Purge Helper plugin by Paul Stoute, Jordan Trask * Jeff Cleverley - [GridPane](https://gridpane.com) * Gareth Bissland - [Weave Digital Studio](https://weave.co.nz) (Fork Author) -## Installation +## Installation from GitHub -### Manual Install -1. Extract the zip file. -2. Upload the extracted folder to the `/wp-content/plugins/` directory on your WordPress installation. -3. Activate the plugin from the Plugins page. +When installing this plugin from GitHub: + +1. Go to the [Releases](https://github.com/weavedigitalstudio/weave-cache-purge-helper/releases) page +2. Download the latest release ZIP file +3. Extract the ZIP file on your computer +4. Rename the extracted folder to remove the version number + (e.g., from `weave-cache-purge-helper-1.1.0` to `weave-cache-purge-helper`) +5. Create a new ZIP file from the renamed folder +6. In your WordPress admin panel, go to Plugins → Add New → Upload Plugin +7. Upload your new ZIP file and activate the plugin + +**Note**: The folder renaming step is necessary for WordPress to properly handle plugin updates and functionality. ## Logging @@ -45,6 +55,13 @@ define( 'WC_PHP_DEBUG', true ); // Custom logging Enable Secure WP Debug via toggle switch then add `define( 'WC_PHP_DEBUG', true );` to your website user-configs.php +## Cache Clearing Order + +This plugin ensures that caches are cleared in the correct order: +1. First: Beaver Builder cache is cleared +2. Second: Nginx Helper or LiteSpeed cache is cleared + +This sequence prevents 404 errors that can occur when Nginx serves cached HTML that references old, non-existent Beaver Builder asset files. ## Fork Information * Original Plugin URI: [Cache Purge Helper on GitHub](https://github.com/managingwp/cache-purge-helper) @@ -52,3 +69,5 @@ Enable Secure WP Debug via toggle switch then add `define( 'WC_PHP_DEBUG', tru ### Note For detailed changes, see the `CHANGELOG.md` file. + +