Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated for WP-Umbrella
  • Loading branch information
gbissland authored Feb 27, 2025
1 parent 3f94486 commit 41ad723
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`.
Expand All @@ -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

Expand All @@ -45,10 +55,19 @@ 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)
* Author of the Fork: Gareth Bissland - [GitHub](https://github.com/gbissland)

### Note
For detailed changes, see the `CHANGELOG.md` file.


0 comments on commit 41ad723

Please sign in to comment.