= Proxy Cache Purge =
Contributors: Ipstenu, mikeschroder, techpriester, danielbachhuber, dvershinin
Tags: proxy, purge, cache, varnish, nginx
Requires at least: 5.0
Tested up to: 6.7
Stable tag: 5.2.2
Requires PHP: 5.6

Automatically empty proxy cached content when your site is modified.

== Description ==

<strong>This plugin <em>does not</em> install nor configure a cache proxy. It acts as an interface with such services.</strong>

One common method of caching content for websites is via the use of reverse proxy caching. Common examples of this are <a href="https://www.varnish-cache.org/">Varnish</a> and <a href="https://www.nginx.com/">Nginx</a>. These systems allow a website to update content and have the visitor's experience cached without the need for complex plugins storing the files locally and using up a user's disk space.

A reverse proxy cache is installed in front of a server and reviews requests. If the page being requested is already cached, it delivers the cached content. Otherwise it generates the page and the cache on demand.

The Proxy Cache Purge plugin sends a request to delete (aka flush) the cached data of a page or post every time it's modified.

= How It Works =

When content on a site is updated by WordPress, the plugin reaches out to the proxy cache service with the URL of the page, requesting the cache be deleted.

Not all page are deleted from the cache on every change. For example, when a post, page, or custom post type is edited, or a new comment is added, <em>only</em> the following pages will purge:

* The front page
* The post/page edited
* Any categories, tags, and/or custom taxonomies associated with the page
* Related feeds
* Associated JSON API pages

In addition, your <em>entire</em> cache will be deleted on the following actions:

* Changing themes
* Pressing the <strong>Empty Cache</strong> button on the toolbar

Plugins can hook into the purge actions as well, to filter their own events to trigger a purge.

On a multisite network using subfolders, only <strong>network admins</strong> can purge the main site.

= Development Mode =

If you're working on a site and need to turn off caching in one of two ways:

1. Add `define( 'VHP_DEVMODE', true );` to your `wp-config.php` file
2. Go to Proxy Cache -> Settings and enable debug mode for 24 hours at a time

That will break cache on page loads. It is _not_ recommended for production!

= WP CLI =

<strong>Purge</strong>

Purge commands let you empty the cache.

* `wp varnish purge` - Flush the cache for your front page
* `wp varnish purge [<url>]` - Flush the cache for one URL

You can use the parameter `--wildcard` to empty everything from that URL down. So if you wanted to empty cache for all themes, you would do this:

* `wp varnish purge https://example.com/wp-content/themes --wildcard`

<strong>Debug</strong>

Debugging can help you figure out why your cache isn't working as well as it could. The default is for your home page, but you can pass any URL on your domain.

* `wp varnish debug [<url>]`

Available parameters:

* `[--include-headers]` --  Include headers in debug check output
* `[--include-grep]` -- Grep active theme and plugin directories for common issues

<strong>DevMode</strong>

Development mode allows you to disable the cache, temporarily.

* `wp varnish devmode [<activate|deactivate|toggle>]` - Change development mode state

= Privacy Policy =

As of version 5, this plugin no longer uses any remote data.

== Installation ==

No special instructions apply.

If you have a 3rd party proxy service (such as Sucuri or Cloudflare) you will need to add an IP address on the <em>Proxy Cache -> Settings</em> page. Alternatively you can add a define to your `wp-config.php` file: `define('VHP_VARNISH_IP','123.45.67.89');`

When using Nginx based proxies, your IP will likely be `localhost`.

= Requirements =

* Pretty Permalinks enabled
* A server based proxy cache service (such as Varnish or Nginx)

== Frequently Asked Questions ==

**Please report all issues in the [support forums](https://wordpress.org/support/plugin/varnish-http-purge)**

If you have code patches, [pull requests are welcome](https://github.com/dvershinin/varnish-http-purge).

= Don't you work at DreamHost? Is this Official or DreamHost only? =

This plugin was originally adopted and updated for DreamHost's DreamPress server, however it is not (and never has been) for DreamHost _only_.

I worked at DreamHost from 2012 to 2022, and have maintained the plugin since around 2014 or so.

As of October 2023, this plugin is _NO LONGER_ installed by default on DreamPress.

= Is this plugin caching my data? =

No. This plugin tells your cache system when content is updated, and to delete the cached data at that time.

= Why doesn't the plugin automatically delete the whole cache? =

Speed and stability. Emptying too much of a cache on every change can slow a server down. This plugin does it's best to determine what needs to be deleted and when, while providing hooks for developers to use as necessary.

= How many cached files are deleted when a post is updated? =

It depends on the post, but in general the tool will delete cached content for:

1. The post name
2. The front page of the site
3. All first pages of related tags/categories
4. The JSON API pages
5. All related RSS feeds

= Is there a limit to how many pages I can purge at once? =

Not really, but in order to prevent your site from crashing by running the same checks over and over, if you try to purge more than 50 URLs at once, the plugin will do a full purge. Normally this never happens, but there are some plugins that hook into the options to add more pages to purge on an update.

You can change this value in your settings, or via the define VHP_VARNISH_MAXPOSTS in your `wp-config.php` file.

Keep in mind, the count of 50 <em>does not</em> include category/tags, API, or RSS pages. It's just the sheer number of individual posts/pages you're trying to purge at once.

= Can I delete the entire cache? =

Yes. Click the 'Empty Cache' button on the "Right Now" Dashboard (see the screenshot if you can't find it). There's also an "Empty Cache" button on the admin toolbar.

If you don't see a button, then your account doesn't have the appropriate permissions. Only administrators can empty the entire cache. In the case of a subfolder multisite network, only the <em>network</em> admins can empty the cache for the primary site.

= Will the plugin delete my cache when I edit files on the server? =

No. WordPress can't detect those file changes so it can't tell your cache what to do. You will need to use the Empty Cache buttons when you're done editing your code.

= Does every WordPress plugin and theme work with a proxy cache? =

No. Some of them have behaviours that causes them not to cache, either by accident or design. It's incredibly hard to debug those, since many of the related issues are contextual (like _if_ you save a page with a special setting). I've done my best to flag everything as possible issues with the debugger.

= I'm a developer, can I tell your cache to empty in my plugin/theme? =

Yes. [Full documentation can be found on Custom Filters in the wiki](https://github.com/dvershinin/varnish-http-purge/wiki/Custom-Filters).

= Can I turn off caching? =

Not permanently, and remember that this plugin is not actually caching your content.

You can use development mode to have WordPress attempt to tell your proxy service not to serve cached content, but the content will still be cached by the service.

There are three ways to do this:

1. Chose 'Pause Cache (24hrs)' from the Cache dropdown menu in your toolbar
2. Go to Proxy Cache -> Settings and enable development mode
3. Add `define( 'VHP_DEVMODE', true );` to your `wp-config.php` file.

The first two options will enable development mode for 24 hours. If you're working on long term development, you can should use the define.

It is _not_ recommended you use development mode on production sites for extended periods of time, as it _will_ will slow your site down and lose all the benefits of caching in the first place.

= Why is the restart cache button missing? =

If you've disabled caching via the define, then you cannot restart cache via the plugin. You would need to change  `define( 'VHP_DEVMODE', true );` to  `define( 'VHP_DEVMODE', false );` in your `wp-config.php` file.

= Why don't I have access to development mode? =

Due to the damage this can cause a site, access is limited to admins only. In the case of a multisite network, only <em>Network Admins</em> can disable caching and they must do so via `wp-config.php` for security.

= Why do I still see cached content in development mode? =

While development mode is on, your server will continue to cache content but the plugin will tell WordPress not to use the cached content. That means files that exist outside of WordPress (like CSS or images) _may_ serve cached content. The plugin does its best to add a No Cache parameter to javascript and CSS, however if a theme or plugin _doesn't_ use proper WordPress enqueues, then their cached content will be shown.

= Why can I still flush cache while in development mode? =

Because the server is still caching content. The plugin provides a way to flush the cache for those pages, as well as anything not included in WordPress, for your convenience.

= How can I tell if everything's caching? =

From your WordPress Dashboard, go to <em>Proxy Cache > Check Caching</em>. There a page will auto-scan your front page and report back any issues found. This includes any known problematic plugins. You can use it to scan any URL on your domain.

= Why is nothing caching when I use PageSpeed? =

PageSpeed likes to put in Caching headers to say <em>not</em> to cache. To fix this, you need to put this in your `.htaccess` section for PageSpeed: `ModPagespeedModifyCachingHeaders off`

If you're using nginx, it's `pagespeed ModifyCachingHeaders off;`

= Why aren't my changes showing when I use CloudFlare or another proxy? =

When you use CloudFlare or any other similar service, you've put a proxy in front of the server's proxy. In general this isn't a bad thing, though it can introduce some network latency (that means your site may run slower because it has to go through multiple layers to get to the content). The problem arises when WordPress tries to send the purge request to your domain name and, with a proxy, that means the proxy service and not your website.

On single-site, you can edit this via the <em>Proxy Cache > Check Caching</em> page. On Multisite, you'll need to add the following to your wp-config.php file: `define('VHP_VARNISH_IP','123.45.67.89');`

Replace `123.45.67.89` with the IP of your <em>Proxy Cache Server</em> (_not_ CloudFlare). **DO NOT** put http in this define. If you're on nginx, you'll want to use `localhost` instead of an IP address.

If you want to use WP-CLI, you can set an option in the database. This will not take precedence over the define, and exists for people who want to use automation tools: `wp option update vhp_varnish_ip 123.45.67.890`

= Why are my posts timing out/not showing when I'm using CloudFlare? =

This is usually related to CloudFlare's APO setup. I have an open ticket with CloudFlare trying to debug this, but basically whatever they're doing with APO doesn't 'like' the flush command and times out (or crashes).

= Why do I get a 503 or 504 error on every post update? =

Your IP address is incorrect. Check the IP of your server and then the setting for your proxy cache IP. If they're _not_ the same, that's likely why.

= How do I find the right IP address? =

Your proxy IP must be one of the IPs that the service is listening on. If you use multiple IPs, or if you've customized your ACLs, you'll need to pick on that doesn't conflict with your other settings.

For example, if you have a Varnish based cache and it's listening on a public and private IP, you'll want to pick the private. On the other hand, if you told Varnish to listen on 0.0.0.0 (i.e. "listen on every interface you can") you would need to check what IP you set your purge ACL to allow (commonly 127.0.0.1 aka localhost), and use that (i.e. 127.0.0.1).

If your web host set up your service, check their documentation.

= What if I have multiple proxy cache IPs? =

You may enter them, separated by a comma, on the settings page.

= What version of Varnish is supported? =

So far this plugin has been reported to successfully function on Varnish v 2 through v 6.5.

= Does this work with Nginx caching? =

It can, if you've configured Nginx caching to respect the curl PURGE request. If this doesn't work, try setting your Varnish IP to `localhost` as Nginx requires a service control installed for the IP address to work.

= What should my cache rules be? =

This is a question beyond the support of plugin. I do not have the resources available to offer any configuration help. Here are some basic gotchas to be aware of:

* To empty any cached data, the service will need to respect the PURGE command
* Not all cache services set up PURGE by default
* When flushing the whole cache, the plugin sends a PURGE command of <code>/.*</code> and sets the `X-Purge-Method` header to `regex`
* Nginx expects the IP address to be 'localhost'

= How can I see what the plugin is sending to the cache service? =

Yes _IF_ the service has an interface. Sadly Nginx does not. [Detailed directions can be found on the debugging section on GitHub](https://github.com/dvershinin/varnish-http-purge/wiki). Bear in mind, these interfaces tend to be command-line only.

= Caching is detected but cannot be confirmed. What does that mean? =

It means that somewhere your server's headers aren't returning the data the plugin needs to see, in order to determine if the cache is working. The most common cause is that your server isn't returning the `X-Varnish` header or the `Age` header.

= I have renamed X-Varnish header for security reasons and Site Health Check says no cache service =

You can use <code>varnish_http_purge_x_varnish_header_name</code> filter to customize this header name, like so:

<code>
function change_varnish_header( $default_header ) {
    return 'My-Custom-Header'; // Replace with the desired header
}
add_filter( 'varnish_http_purge_x_varnish_header_name', 'change_varnish_header' );
</code>

== Changelog ==

= 5.2.2 =
* August 2024
* Fix undefined variable $rest_api_route

= 5.2.1 =
* January 2024
* Allow custom X-Varnish header name.

= 5.2.0 =
* July 2023
* Fix debug for if Via headers are an array (props @iverok)

== Screenshots ==

1. Purge button on Right Now (Dashboard Admin)
2. Toolbar menu (with cache enabled)
3. Toolbar menu (with cache disabled)
4. Scanner results
5. Change Proxy IP address
6. Activate Dev Mode
7. Dev Mode Warning (24 hour notice)
