evista/pj-page-cache-red

Redis backed page cache

v0.1.52 2017-04-02 13:33 UTC

Requires

• php: ^7.0
• cheprasov/php-redis-client: ^1.6
• johnpbloch/wordpress: ^4.7

Requires (Dev)

• peridot-php/peridot: ^1.19
• peridot-php/peridot-prophecy-plugin: ~1.0

MIT

README

A Redis-backed full page caching plugin for WordPress, extremely flexible and fast. Requires a running Redis server, a Redis client package (currently only cheprasov/php-redis-client is supported), and Composer

Requirements

Redis server:

sudo apt-get install redis-server

This fork of the original package is being actively refactored to use a Redis package instead of the Redis PECL extension and to add some test coverage. My most important plan is to add an interface to hint the current dependency injection, and add more tests.

Make sure your Redis server has enough memory allocated to store your cached pages. The plugin compresses cached pages using gzip to lower memory usage. We recommend anywhere from 16 mb allocated just for page caching. Increase according to your hit-rate. We also recommend disabling flushing Redis cache to disk, and the allkeys-lru eviction policy to ensure the server can make more room for new cached pages by evicting older ones. Here is a sample extract from the redis.conf file:

maxmemory 16m
maxmemory-policy allkeys-lru

Don't forget to restart the Redis server after making changes to the configuration file.

Installing the WordPress Plugin

Install the plugin via composer then activate it. It adds the advanced-cache.php file as a symlink into the wp-contents folder:

composer require evista/pj-page-cache-red

Enable page caching in your WordPress wp-config.php file with a constant:

define( 'WP_CACHE', true );
define('REDIS_CACHE', true);

Set up some important Redis options (both has defaults):

define('REDIS_CACHE_TTL', 3000);
define('REDIS_DB', 10);
define('REDIS_HOST', getenv('REDIS_HOST') ?: '127.0.0.1');
define('REDIS_PORT', getenv('REDIS_PORT') ?: 6379);

Try visiting your site in incognito mode or cURL, you should see an X-Pj-Cache- header:

curl -v https://example.org -o /dev/null
< X-Pj-Cache-Status: hit

That's it!

Purging Cache

By default, this plugin will expire posts (pages, cpt) whenever they are published or updated, including the front page and any RSS feeds. You may also choose to expire certain URLs or cache flags at certain other events. For example:

// Expire cache by post ID (argument can be an array of post IDs):
Redis_Page_Cache::clear_cache_by_post_id( $post->ID );

// Expire cache by URL (argument can be an array of URLs):
Redis_Page_Cache::clear_cache_by_url( 'https://example.org/secret-page/' );

// Expire cache by flag (argument can be an array):
Redis_Page_Cache::clear_cache_by_flag( array( 'special-flag' ) );

Wait, what the heck are flags?

Redis Page Cache stores a set of flags with each cached item. These flags allow the plugin to better target cached entries when flushing. For example, a single post can have multiple URLs (cache buckets, request variables, etc.) and thus, multiple cache keys:

https://example.org/?p=123
https://example.org/post-slug/
https://example.org/post-slug/page/2/
https://example.org/post-slug/?show_comments=1

These URLs will have unique cache keys and contents, but Redis Page Cache will flag them with a post ID, so you can easily purge all three items if you know the flag:

$post_id = 123;
$flag = sprintf( 'post:%d:%d', get_current_blog_id(), $post_id );

Redis_Page_Cache::clear_cache_by_flag( $flag );

You can add your own custom flags to requests too:

// Flag all single posts with a tag called my-special-tag:
if ( is_single() && has_tag( 'my-special-tag' ) ) {
    Redis_Page_Cache::flag( 'my-special-tag' );
}

// And whenever you need to:
Redis_Page_Cache::clear_cache_by_flag( 'my-special-tag' );

Note that all the clear cache methods expire (but don't delete) cache by default. If you're running in an environment where background cache regeneration is available, an expired flag will cause that background regeneration while serving a stale copy to the visitor. If this is not the desired behavior, you can use the optional $expire argument in the clear cache methods (set to false) to force delete a flag/URL.

Support

If you need help installing and configuring this plugin, feel free to reach out to us via e-mail: [e-mail].