Proxy Cache Purge

FAQ

Veuillez signaler tous les problèmes sur forum de support

If you have code patches, pull requests are welcome.

Vous ne travaillez pas chez DreamHost ? Est-ce officiel ou DreamHost uniquement ?

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.

Today, the plugin is maintained by GetPageSpeed, with a focus on advanced NGINX and proxy caching deployments and strong compatibility with the NGINX cache-purge module from the NGINX Extras collection.

Cette extension met-elle en cache mes données ?

Non. Cette extension informe votre système de cache lorsque le contenu est mis à jour et supprime les données mises en cache à ce moment-là.

Pourquoi l’extension ne supprime-t-elle pas automatiquement tout le cache ?

Speed and stability. Emptying too much of a cache on every change can slow a server down. This plugin does its 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 does not 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 prevent purges for drafts or other post statuses?

Yes. If your environment doesn’t cache logged-in users and you want to avoid purge noise from autosaves/drafts, you can exclude specific statuses network‑wide via wp-config.php (multisite‑friendly).

Add a define to exclude drafts:

define( 'VHP_EXCLUDED_POST_STATUSES', 'draft' );

Exclude multiple statuses (comma‑separated):

define( 'VHP_EXCLUDED_POST_STATUSES', 'draft,pending' );

Or pass an array:

define( 'VHP_EXCLUDED_POST_STATUSES', array( 'draft', 'pending' ) );

Developers can also use a filter to adjust the valid statuses programmatically:

add_filter( 'varnish_http_purge_valid_post_statuses', function( $statuses, $post_id ) {
    return array_diff( $statuses, array( 'draft' ) );
}, 10, 2 );

By default, the plugin considers these statuses for purge URL generation: publish, private, trash, pending, draft.

Puis-je supprimer la totalité du cache ?

Oui. Cliquez sur le bouton « Vider le cache » sur le Tableau de bord « Immédiatement » (voir la capture d’écran si vous ne le trouvez pas). Il y a aussi un bouton « Vider le cache » sur la barre d’outils d’administration.

Si vous ne voyez pas de bouton, votre compte ne dispose pas des autorisations appropriées. Seuls les administrateurs/administratrices peuvent vider l’intégralité du cache. Dans le cas d’un réseau multisite sous-dossier, seuls les administrateurs/administratrices réseau peuvent vider le cache du site principal.

L’extension supprimera-t-elle mon cache lorsque je modifierai des fichiers sur le serveur ?

Non. WordPress ne peut pas détecter ces changements de fichiers de sorte qu’il ne peut pas dire à votre cache quoi faire. Vous devrez utiliser les boutons Vider le cache lorsque vous aurez fini de modifier votre code.

Est-ce que toutes les extensions et thèmes WordPress fonctionnent avec un cache proxy ?

No. Some of them have behaviours that cause 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.

Je suis développeur/développeuse, puis-je dire à votre cache de se vider dans mon extension/thème ?

Yes. Full documentation can be found on Custom Filters in the wiki.

Puis-je désactiver la mise en cache ?

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.

Il y a trois façons de faire ceci :

1. Choose ‘Pause Cache (24hrs)’ from the Cache dropdown menu in your toolbar
2. Accédez aux réglages du cache proxy -> et activez le mode de développement
3. Ajouter define( 'VHP_DEVMODE', true ); à votre fichier wp-config.php.

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

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

Pourquoi le bouton de redémarrage du cache est-il manquant ?

Si vous avez désactivé la mise en cache via le define, vous ne pouvez pas redémarrer le cache via l’extension. Vous devrez changer define( 'VHP_DEVMODE', true ); en define( 'VHP_DEVMODE', false ); dans votre wp-config.php fichier.

L’extension supprimera-t-elle mon cache lorsque j’éditerai des fichiers sur le serveur ?

En raison des dommages que cela peut causer à un site, l’accès est limité aux administrateurs uniquement. Dans le cas d’un réseau multisite, seuls les administrateurs réseau peuvent désactiver la mise en cache et ils doivent le faire via wp-config.php pour des raisons de sécurité.

Pourquoi est-ce que je vois toujours du contenu mis en cache en mode développement ?

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.

Pourquoi puis-je encore vider le cache en mode développement ?

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.

Comment puis-je savoir si tout est en cache ?

From your WordPress Dashboard, go to Proxy Cache > Check Caching. 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.

Pourquoi rien n’est-il mis en cache lorsque j’utilise PageSpeed ?

PageSpeed aime mettre des en-têtes Caching pour dire de ne pas mettre en cache. Pour corriger ce problème, vous devez mettre ceci dans votre section .htaccess pour PageSpeed : ModPagespeedModifyCachingHeaders off

Si vous utilisez NGINX, c’est pagespeed ModifyCachingHeaders off;

Pourquoi mes modifications ne s’affichent-elles pas lorsque j’utilise CloudFlare ou un autre proxy ?

Lorsque vous utilisez CloudFlare ou tout autre service similaire, vous avez mis un proxy devant le proxy du serveur. En général, ce n’est pas une mauvaise chose, même si cela peut introduire une certaine latence du réseau (cela signifie que votre site peut fonctionner plus lentement car il doit traverser plusieurs couches pour accéder au contenu). Le problème survient lorsque WordPress essaie d’envoyer la demande de purge à votre nom de domaine et, avec un proxy, cela signifie le service proxy et non votre site web.

Sur un site unique, vous pouvez le modifier via le Cache proxy > Vérifiez la page mise en cache. Sur multisite, vous devrez ajouter ce qui suit à votre fichier wp-config.php : define('VHP_VARNISH_IP','123.45.67.89');

Remplacez 123.45.67.89 par l’adresse IP de votre serveur de cache proxy (pas CloudFlare). NE PAS mettre http dans cette définition. Si vous êtes sur nginx, vous voudrez utiliser localhost au lieu d’une adresse IP.

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.89

Pourquoi mes articles expirent/ne s’affichent-ils pas lorsque j’utilise 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).

Pourquoi est-ce que j’obtiens une erreur 503 ou 504 à chaque mise à jour d’un article ?

Votre adresse IP est incorrecte. Vérifiez l’adresse IP de votre serveur, puis le réglage de l’adresse IP de votre cache proxy. S’ils ne sont pas identiques, c’est probablement pour cette raison.

Comment trouver la bonne adresse IP ?

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 one that doesn’t conflict with your other settings.

Par exemple, si votre cache proxy écoute sur une IP publique et privée, choisissez la privée. D’autre part, si vous avez demandé à Varnish d’écouter sur 0.0.0.0 (p. ex. « écouter sur toutes les interface possibles »), vous devrez vérifier quelle IP vous définissez commme votre ACL de purge pour autoriser (généralement 127.0.0.1 c’est à dire localhost), et l’utiliser (p. ex. 127.0.0.1 ou localhost).

Si votre hébergeur a configuré votre service, vérifiez sa documentation.

Que faire si j’ai plusieurs adresses IP de cache proxy ?

Vous pouvez les saisir, séparés par une virgule, sur la page des réglages.

Quelle version de Varnish est prise en charge ?

So far this plugin has been reported to successfully function on Varnish v2 through v6.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.

Quelles devraient être mes règles de cache ?

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

• Pour vider les données mises en cache, le service devra respecter la commande PURGE
• Tous les services de cache ne configurent pas PURGE par défaut
• Lors du vidage de l’ensemble du cache, l’extension envoie une commande PURGE de /.* et définit l’en-tête X-Purge-Method comme regex
• NGINX expects the IP address to be ‘localhost’

How do I pass a Varnish control key or auth header?

Some providers require a control key, token, or Authorization header to accept PURGE requests. You can set a header name and value via the settings page or via the following constant:

define( 'VHP_VARNISH_EXTRA_PURGE_HEADER', 'X-Control-Key: YOUR_CONTROL_KEY_HERE' );

Alternatively, you can inject any required header via a filter.

1. Set where PURGE requests should be sent (host:port, no scheme):

   define( ‘VHP_VARNISH_IP’, ‘varnish.example.com:6081’ );

2. Add your control key/auth header via a small MU plugin so it loads on every request. Create wp-content/mu-plugins/varnish-purge-auth.php with:

   <?php
   add_filter( ‘varnish_http_purge_headers’, function( $headers ) {
   // Example: provider expects a custom key header
   $headers[‘X-Control-Key’] = ‘YOUR_CONTROL_KEY_HERE’;

   // Or use Authorization headers:
   // $headers['Authorization'] = 'Basic ' . base64_encode( 'username:password' );
   // $headers['Authorization'] = 'Bearer ' . 'YOUR_TOKEN_HERE';
   
   return $headers;
   

   } );

If your provider requires HTTPS for the purge endpoint, force the schema:

add_filter( 'varnish_http_purge_schema', function() { return 'https://'; } );

Important: This plugin sends HTTP PURGE requests to your cache service. It does not use the Varnish management interface (varnishadm/secret on port 6082).

Comment puis-je voir ce que l’extension envoie au service de cache ?

Yes IF the service has an interface. Sadly NGINX does not. Detailed directions can be found on the debugging section on GitHub. 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 varnish_http_purge_x_varnish_header_name filter to customize this header name, like below to resolve this:

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' );