Cache control by Cacholong

Cronjob Settings

• Cronjob purging: Enable or disable cronjob purging.
• 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.
• Purge caches Select caches to purge on given cronjob time.

hosts.json

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 one with this plugin. Default path is: wp-content/uploads/cacholong-cache-control/hosts.json.

Here is an example of a hosts.json file:

{"servers": [ {"name": "server1", "ip": "127.0.0.1", "fastcgi": false}, {"name": "server2", "ip": "127.0.0.2", "fastcgi": true}, ] }

Each line contains information about one server. Parameters:

• name (string) Name of host, something to identify this server.
• ip (string) IP address of server or full url. Format: scheme://host:port/path
• fastcgi (bool) Server user Nginx FastCGI (true) or not (false)

When there is no hosts.json or the path is invalid, this plugin assumes the following:

{"servers": [ {"name": "localhost", "ip": "127.0.0.1", "fastcgi": true} ] }

How does it work

“Cache control by Cacholong” empties partial or full cache for Nginx FastCGI cache. WordPress HTTP API is used to make (post) request to 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.

There are several settings to tweak purging, see Settings > Cache control.

WP-CLI

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.

WP-CLI exit codes

Exit codes are 0 (no errors) or 1 (generic error).

WP-CLI examples

Purge command with all arguments:

wp cacholong_cc purge [--cache=<cache>] [--ips=<ips>]

Purge Nginx FastCGI:

wp cacholong_cc purge --cache=fastcgi

Purge all caches:

wp cacholong_cc purge --cache=all wp cacholong_cc purge

Purge all caches for ip address 127.0.0.1 and 127.0.0.2:

wp cacholong_cc purge --ips=127.0.0.1,127.0.0.2

Factory reset options for given site_id or current blog if no site_id is given:

wp cacholong_cc factory_reset [--site_id=site_id]

Debug

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