Carl Alberto

Uploads Relay makes local WordPress development easier and lightweight by automatically proxying missing upload files from a remote server. No need to download gigabytes of media just to work on a site locally.
<h4>Features</h4>
<ul>
<li>Proxy Missing Files — Automatically serve missing upload files from a remote server.</li>
<li>Always Remote Mode — Rewrite all upload URLs to point to the remote server for the fastest setup.</li>
<li>Optional Local Caching — Cache proxied files locally so subsequent requests are served from disk.</li>
<li>Security First — Path traversal protection, host allowlisting, and file extension validation.</li>
<li>Environment Guard — Only active when WordPress environment type is set to “local”.</li>
<li>Zero Configuration on Remote — No changes needed on the remote/production server.</li>
</ul>
<h4>How It Works</h4>
<ol>
<li>A visitor or developer requests an upload file (e.g., an image in a post).</li>
<li>If the file does not exist locally, WordPress returns a 404.</li>
<li>The plugin intercepts the 404, fetches the file from the configured remote server, and serves it.</li>
<li>Optionally, the file is cached locally for faster subsequent loads.</li>
</ol>
<h4>Use Cases</h4>
<ul>
<li>Local development of large WordPress sites without syncing media.</li>
<li>Staging environments with partial media libraries.</li>
<li>Quick site clones for debugging or testing.</li>
</ul>
<h4>Requirements</h4>
<ul>
<li>WordPress 6.0 or higher</li>
<li>PHP 7.4 or higher</li>
<li><code>WP_ENVIRONMENT_TYPE</code> must be set to <code>local</code> (the plugin will not function in production environments)</li>
</ul>
<h4>External Service</h4>
This plugin sends HTTP requests to a remote server that you configure yourself in order to fetch upload files missing from your local environment. No requests are made until you explicitly enter a remote URL and enable the proxy in Settings → Uploads Relay. By enabling the plugin and providing a remote URL, you consent to these requests being made.
<ul>
<li>What is sent: HTTP GET requests for specific media file paths (e.g., <code>/wp-content/uploads/2024/01/photo.jpg</code>).</li>
<li>When it is sent: Only when a requested upload file does not exist locally, the proxy is enabled, and the environment type is <code>local</code>.</li>
<li>Where it is sent: Only to the remote server URL you have configured. This is typically your own production or staging server.</li>
<li>No data is collected, stored, or transmitted to any third-party service, analytics provider, or external server other than the one you configure.</li>
<li>No telemetry, tracking, or usage data is collected by this plugin.</li>
</ul>
Since the remote server is your own, its terms of service and privacy policy are governed by your own hosting provider.

Uploads Relay for Local Development by Carl Alberto

Proxy missing upload files from a remote server during local development. No need to download the entire uploads folder.

Daniel Bachhuber

Ipstenu (Mika Epstein)

Danila Vershinin

Mike Schroder

Kira Schroder

techpriester

This plugin does not install nor configure a cache proxy. It acts as an interface with such services.
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/" rel="nofollow ugc">Varnish</a> and <a href="https://www.nginx.org/" rel="nofollow ugc">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.
<h4>How It Works</h4>
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 pages 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, only the following pages will purge:
<ul>
<li>The front page</li>
<li>The post/page edited</li>
<li>Any categories, tags, and/or custom taxonomies associated with the page</li>
<li>Related feeds</li>
<li>Associated JSON API pages</li>
</ul>
In addition, your entire cache will be deleted on the following actions:
<ul>
<li>Changing themes</li>
<li>Pressing the Empty Cache button on the toolbar</li>
</ul>
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 network admins can purge the main site.
<h4>Keep Your Cache Warm</h4>
Purging is only half the story. Once Proxy Cache Purge empties a page, the cache for that URL is gone, so the next visitor triggers a full uncached render and waits for it. On busy sites this “cache stampede” shows up as slow pages right after every update.
<a href="https://www.getpagespeed.com/cacheability-pro?ref=vhp-readme" rel="nofollow ugc">Cacheability Pro</a> is a companion plugin that closes that gap: it automatically re-warms purged URLs in the background so visitors keep hitting fast, cached responses, and it tunes your cache headers so more of your pages stay cacheable in the first place. Proxy Cache Purge handles invalidation; Cacheability Pro handles everything around it.
<h4>Monitor Your Cache</h4>
Proxy Cache Purge keeps your cache fresh, but how often is it actually being hit? If you run your own Varnish or NGINX server, <a href="https://amplify.getpagespeed.com/?ref=vhp-amplify-readme" rel="nofollow ugc">GetPageSpeed Amplify</a> shows your cache hit rate, request volume, and backend health over time, with a free tier. Proxy Cache Purge handles invalidation; Amplify shows you whether the cache is doing its job.
<h4>Development Mode</h4>
If you’re working on a site and need to turn off caching in one of two ways:
<ol>
<li>Add <code>define( 'VHP_DEVMODE', true );</code> to your <code>wp-config.php</code> file</li>
<li>Go to Proxy Cache -> Settings and enable Debug Mode for 24 hours at a time</li>
</ol>
That will break cache on page loads. It is not recommended for production!
<h4>Cache Tags (BETA)</h4>
As of version 5.4.0, Proxy Cache Purge includes an optional Cache Tags / Surrogate Keys purge mode. This feature is marked as BETA and is disabled by default.
When enabled, the plugin:
<ul>
<li>Adds cache-tag headers to WordPress responses (for example, tagging pages by post ID, post type, taxonomy terms, author, and archives).</li>
<li>Uses tag-based purges instead of individual URL purges when content is updated, which can reduce purge traffic and improve consistency on complex sites.</li>
</ul>
Requirements:
<ul>
<li>A proxy cache that supports Cache Tags / Surrogate Keys and advertises this via standard <code>Surrogate-Capability</code> headers (for example, <code>Surrogate-Capability: vhp="Surrogate/1.0 tags/1"</code>).</li>
</ul>
How to enable:
<ul>
<li>Go to Proxy Cache → Settings → Purge Method and check “Use Cache Tags (Surrogate Keys)”. The checkbox is only enabled when your cache tells WordPress it supports tags (or when you explicitly enable it via a define).</li>
<li>
Alternatively, you can force-enable or force-disable detection via <code>wp-config.php</code>:
define( ‘VHP_VARNISH_TAGS’, true ); // Force treat cache as tag-capable 
define( ‘VHP_VARNISH_TAGS’, false ); // Force treat cache as not tag-capable
</li>
</ul>
Because this feature depends on your cache configuration, it is recommended that you test it carefully in staging before enabling it on production.
<h4>Background Purging with WP-Cron</h4>
On busy sites, sending many PURGE requests directly from admin requests can slow things down. When you define <code>DISABLE_WP_CRON</code> as <code>true</code> in <code>wp-config.php</code> (because you are running a real system cron that calls <code>wp-cron.php</code>), Proxy Cache Purge automatically switches to an asynchronous mode:
<ul>
<li>Purge requests (both URL-based and tag-based, when Cache Tags are enabled) are collected into a small per-site queue.</li>
<li>The queue is processed by WP-Cron in the background, keeping your admin and content-editing actions responsive even when many URLs or tags must be invalidated.</li>
</ul>
Object-cache purges (the “Purge Database Cache” option) remain synchronous and are not affected by this behaviour. The Proxy Cache settings page and Site Health integration expose basic queue status so you can verify that background purging is healthy; if the queue appears large or very old, check that your system cron is correctly invoking WordPress cron.
Important: Cron Frequency and Cache Freshness
When using background purging, the frequency of your system cron determines how quickly cache invalidations are processed. The longer the interval between cron runs, the longer visitors may see stale content after updates.
For minimal stale content, run your system cron every minute:
<pre><code>* * * * * /usr/bin/php /var/www/html/wp-cron.php
</code></pre>
If you can tolerate slightly longer delays, every 2-5 minutes is also acceptable. However, running cron less frequently (e.g., every 15 minutes) means cache purges may be delayed by that amount after content changes.
Note: Scheduled posts are handled specially. When a scheduled post is published via WP-Cron, the cache is purged synchronously within the same cron run, ensuring immediate cache invalidation without waiting for the next cron execution.
For detailed instructions on setting up a proper Linux-based WordPress cron, see: <a href="https://www.getpagespeed.com/web-apps/wordpress/wordpress-cron-optimization" rel="nofollow ugc">WordPress Cron Optimization</a>.
Disabling Background Purging
If you have <code>DISABLE_WP_CRON</code> defined but do not want background purging (for example, on low-traffic sites where immediate purges are preferred), you can force-disable cron-based purging by adding this to your <code>wp-config.php</code>:
<pre><code>define( 'VHP_DISABLE_CRON_PURGING', true );
</code></pre>
With this constant set, all cache purges will execute immediately during the request, regardless of the <code>DISABLE_WP_CRON</code> setting.
<h3>WP-CLI</h3>
Purge
Purge commands let you empty the cache.
<ul>
<li><code>wp varnish purge</code> – Flush the entire site cache (equivalent to clicking “Empty Cache” in admin)</li>
<li><code>wp varnish purge --all</code> – Explicitly flush the entire site cache</li>
<li><code>wp varnish purge <url></code> – Flush cache for a specific URL and all content below it (wildcard)</li>
<li><code>wp varnish purge <url> --url-only</code> – Flush cache for only the exact URL specified (no wildcard)</li>
<li><code>wp varnish purge --tag=<tag></code> – Flush cache by tag (requires Cache Tags mode to be enabled)</li>
</ul>
Examples:
<ul>
<li><code>wp varnish purge</code> – Purge entire site</li>
<li><code>wp varnish purge --all</code> – Same as above, more explicit</li>
<li><code>wp varnish purge https://example.com/hello-world/</code> – Purge this URL and everything below it</li>
<li><code>wp varnish purge https://example.com/hello-world/ --url-only</code> – Purge only this exact URL</li>
<li><code>wp varnish purge https://example.com/wp-content/themes/ --wildcard</code> – Purge all theme files</li>
<li><code>wp varnish purge --tag=p-123</code> – Purge all pages tagged with post ID 123</li>
<li><code>wp varnish purge --tag=pt-post</code> – Purge all cached pages of post type “post”</li>
</ul>
Debug
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.
<ul>
<li><code>wp varnish debug [<url>]</code></li>
</ul>
Available parameters:
<ul>
<li><code>[--include-headers]</code> — Include headers in debug check output</li>
<li><code>[--include-grep]</code> — Grep active theme and plugin directories for common issues</li>
</ul>
DevMode
Development mode allows you to disable the cache, temporarily.
<ul>
<li><code>wp varnish devmode [<activate|deactivate|toggle>]</code> – Change development mode state</li>
</ul>
Async purge queue (cron-mode)
When you define <code>DISABLE_WP_CRON</code> as <code>true</code> and run a real system cron for WordPress, Proxy Cache Purge can move heavy purge work into a small background queue that is processed by WP‑Cron.
You can inspect and manage that queue via WP‑CLI:
<ul>
<li><code>wp varnish queue status</code> – show whether cron-mode is active, if a full purge is queued, counts of queued URLs/tags, and the last queue run time.</li>
<li><code>wp varnish queue process</code> – process any items currently in the queue (useful to run after deploys or cache‑sensitive operations).</li>
<li><code>wp varnish queue clear</code> – clear the queue without sending any PURGE requests.</li>
</ul>
These commands do not replace your normal WordPress cron (you still need a cron entry that calls <code>wp cron event run --due-now</code> or hits <code>wp-cron.php</code>), but they give you a simple operational handle when using cron‑mode.
<h4>Understanding Purge Behavior</h4>
There are different types of cache purges, and they behave differently:
Manual Purges (Admin Bar)
<ul>
<li>“Purge Cache (All Pages)” – Sends a single regex purge request to invalidate the entire cache. Always executes immediately.</li>
<li>“Purge Cache (this page)” – Purges only the exact URL you’re viewing. Always executes immediately.</li>
</ul>
Manual purges are always immediate, even when background cron-mode is enabled. This is intentional: when you click a button, you expect immediate results.
Automatic Purges (Post Save/Update)
When you save or update a post, the plugin automatically purges:
<ul>
<li>The post’s URL</li>
<li>The homepage</li>
<li>Category archive pages</li>
<li>Tag archive pages</li>
<li>Author archive page</li>
<li>Date-based archives</li>
<li>RSS feeds</li>
<li>Related REST API endpoints</li>
</ul>
This can be 20-50+ URLs depending on your site structure. When cron-mode is enabled, these automatic purges are queued and processed in the background to avoid slowing down the post editor.
Key Difference
 Action 
 URLs Purged 
 Uses Cron Queue?
 “Purge Cache (All Pages)” 
 1 (regex) 
 No – always immediate
 “Purge Cache (this page)” 
 1 
 No – always immediate
 Post save/update 
 20-50+ 
 Yes (if cron-mode enabled)
If you need to immediately purge all URLs related to a specific post (not just the post URL), save the post – the automatic purge will handle all related URLs.

Proxy Cache Purge

Automatically empty proxy cached content when your site is modified.

Uploads Relay for Local Development by Carl Alberto vs Proxy Cache Purge