Preliot

Cacholong

<p>“Cache control by Cacholong” plugin automates purging of Nginx Pagespeed cache and Nginx FastCGI cache on your Nginx server(s). It is a backend plugin that is able to:</p>
<ul>
<li>Purge Nginx Pagespeed cache and/or Nginx FastCGI cache.</li>
<li>Purge cache automatically, manually, with WordPress cronjobs and WP-CLI.</li>
<li>Purge caches on one or more servers (See hosts.json section for more details).</li>
<li>Use commandline (WP-CLI) to purge caches or reset to factory settings.</li>
<li>Remove id tag from stylesheet link tags, in order to allow Nginx Pagespeed to combine stylesheets.</li>
<li>Allow purging of other cached items (see Settings > Cache control).</li>
<li>Inform user of purge status.</li>
<li>Support for single site and network sites</li>
<li>Support for WP-CLI</li>
<li>Support for WPML (including language negotiation type domain)</li>
</ul>
<h4>When will it purge?</h4>
<p>This plugin will work with default and custom post types. It will purge on a save, regular update, quick edit update, slug change, delete and undelete. The user is informed with one or more messages.<br />
There are a few caveats:</p>
<ul>
<li>When a user is using the Gutenberg editor, purge messages will not be displayed.</li>
<li>When the user uses “Quick edit” and “Updates” the post, no messages will be displayed, because there’s no page refresh. Those messages will be shown on the next request. </li>
</ul>
<p>It is possible to purge with WordPress cronjobs. Adjust the ‘Cronjob settings’ to perform a daily purge of caches.</p>
<p>You can also purge items manually. Go to the WordPress dashboard and navigate to:</p>
<ul>
<li>Settings > Cache control > purge single item</li>
<li>Settings > Cache control > purge all caches</li>
<li>Admin Toolbar > purge all caches</li>
</ul>
<h4>Settings</h4>
<ul>
<li>File with hosts (JSON):                 File with information about one or more hosts for this WordPress installation. See hosts.json section for more details. </li>
<li>Pagespeed optimized CSS:                Remove ID tag from all WordPress stylesheet link tags to improve Nginx Pagespeed caching. Will only work on frontend.</li>
<li>Purge settings default post types:      Select one or more options when purging a default post type. Possible to purge post url (default), home page, all connected WordPress categories or all caches.</li>
<li>Purge settings default custom type(s):  Select one or more options when purging a custom post type. Possible to purge post url (default), home page, all connected WordPress categories or all caches.</li>
</ul>
<h4>Cronjob Settings</h4>
<ul>
<li>Cronjob purging:                        Enable or disable cronjob purging. </li>
<li>Cronjob time of each day:               Enter HH:MM in 24 hour notation for cronjob time of day. Will fallback to 00:00 when wrong format is given.</li>
<li>Purge caches                            Select caches to purge on given cronjob time. </li>
</ul>
<h4>hosts.json</h4>
<p>Hosts.json is a JSON file with information about one or more servers for this WordPress installation. Remember that this file must contain information about all servers, including the<br />
one with this plugin. Default path is: wp-content/uploads/cacholong-cache-control/hosts.json.</p>
<p>Here is an example of a hosts.json file:</p>
<pre><code>{"servers":
    [
        {"name": "server1", "ip": "127.0.0.1", "pagespeed": true, "fastcgi": false},
        {"name": "server2", "ip": "127.0.0.2", "pagespeed": false, "fastcgi": true},
    ]
}
</code></pre>
<p>Each line contains information about one server. Parameters:</p>
<ul>
<li>
<p>name (string)<br />
Name of host, something to identify this server.</p>
</li>
<li>
<p>ip (string)<br />
IP address of server or full url. Format: scheme://host:port/path</p>
</li>
<li>
<p>pagespeed (bool)<br />
Server uses Nginx Pagespeed (true) or not (false)</p>
</li>
<li>
<p>fastcgi (bool)<br />
Server user Nginx FastCGI (true) or not (false)</p>
</li>
</ul>
<p>When there is no hosts.json or the path is invalid, this plugin assumes the following:</p>
<pre><code>{"servers":
    [
        {"name": "localhost", "ip": "127.0.0.1", "pagespeed": true, "fastcgi": true}
    ]
}
</code></pre>
<h4>How does it work</h4>
<p>“Cache control by Cacholong” empties partial or full cache for Nginx Pagespeed and FastCGI cache. WordPress HTTP API is used to make (post) request to<br />
specific urls to trigger purges. Based on the http header responses this plugin determines if a purge is successful or not. The user is informed with messages, which are loaded after a purge and page refresh.</p>
<p>There are several settings to tweak purging, see Settings > Cache control.</p>
<h4>WP-CLI</h4>
<p>There are several commands available for the commandline with wp-cli. Commands generate text output which can be suppressed with –quiet. When an error occurs, text will always be displayed.</p>
<h4>WP-CLI exit codes</h4>
<p>Exit codes are 0 (no errors) or 1 (generic error).</p>
<h4>WP-CLI examples</h4>
<p>Purge command with all arguments:</p>
<pre><code>wp cacholong_cc purge [--cache=<cache>] [--ips=<ips>]
</code></pre>
<p>Purge Nginx FastCGI:</p>
<pre><code>wp cacholong_cc purge --cache=fastcgi
</code></pre>
<p>Purge Nginx Pagespeed:</p>
<pre><code>wp cacholong_cc purge --cache=pagespeed
</code></pre>
<p>Purge all caches:</p>
<pre><code>wp cacholong_cc purge --cache=all
wp cacholong_cc purge
</code></pre>
<p>Purge Nginx Pagespeed cache for ip address 127.0.0.1 and 127.0.0.2:</p>
<pre><code>wp cacholong_cc purge --cache=pagespeed --ips=127.0.0.1,127.0.0.2
</code></pre>
<p>Purge all caches for ip address 127.0.0.1 and 127.0.0.2:</p>
<pre><code>wp cacholong_cc purge --ips=127.0.0.1,127.0.0.2
</code></pre>
<p>Factory reset options for given site_id or current blog if no site_id is given:</p>
<pre><code>wp cacholong_cc factory_reset [--site_id=site_id]
</code></pre>
<h4>Debug</h4>
<p>Plugin will log basic purge information when WP_DEBUG is true (can be set in wp-config.php). Logs information in file wp-content/cacholong-cache-control.log.<br />
Plugin will log wp_remote_request details when CACHOLONG_CACHE_DEBUG_HTTP_API_REQUEST is true (can be set in wp-config.php). Logs information in file wp-content/cacholong-cache-control.log.</p>


Cache control by Cacholong

“Cache control by Cacholong” is a cache control plugin for one or more Nginx servers.

W3 Total Cache vs Cache control by Cacholong