README

WpCacheController

WordPress library for caching arbitrary data with automatic invalidation

WpCacheController is WordPress library for caching arbitrary data with automatic invalidation. It is framework-agnostic so no other packages are needed for its proper operation.

This lib constantly updates log and statistics records to inform an administrator about cache usage.

There is admin dashboard settings page where administrator can enable/disable caching function and see log records and statistics.

Typical usage for this library is to substitute code blocks that have to access database several times to prepare HTML content, for example: navigation block, category tree, footer, the latest blog posts block, related products block,...

Usage:

Put this in "functions.php" of yours theme to initialize the controller where parameter is path to configuration file:

use Tekod\WpCacheController\CacheController;
require_once 'inc/WpCacheController/CacheController.php';  // optional if you use some autoloader
CacheController::Init(__DIR__.'/config/cachecontroller.config.php');

Example of configuration is part of this lib. It is highly recommended to clone (and rename) configuration file outside of lib directory and edit content there, just like in code above. That way you can safely update library without losing configuration.

This will echo HTML content identified as "product menu" from cache or include template if not:

CacheController::Profile('eCommerce')->Output('product menu', function() {
    get_template_part('template-parts/woocommerce_product_menu');
});

Here is how to pass parameter to inner function (closure) to create a dynamic identifier:

CacheController::Profile('Shop')->Output('product-page-'.$ProductID, function() use ($ProductID) {
     $Product= new MyProduct($ProductID);
     $Title= $Product->GetTitle();
     $Image= $Product->GetImage();
     include 'shop/single-product.php';
});

Instead of echoing content use "Get()" to just return arbitrary data, typical use case is to replace fetching values from a database with heavy SQL queries

$Data= CacheController::Profile('Movies')->Get('full-movie-data-'.$ID, function() use ($ID) {
     return [
         'Movie' => get_post($ID),
         'Genres' => get_posts(['posts_per_page' => -1, 'post_type' => 'genre', 'tax_query' => [.....
         'Actors' => get_posts(['posts_per_page' => -1, 'post_type' => 'actor', 'tax_query' => [.....
         'Photos' => get_posts(['posts_per_page' => -1, 'post_type' => 'photo', 'tax_query' => [.....
         ....
     ];
});

Note: identifiers must contain only filename-safe chars (regex: "A-Za-z0-9~_!&= |.-+") easiest method to ensure that is to pass it through md5 func, like:

CacheController::Profile('IMDB')->Get(md5($URL), function() {...

3rd parameter

Methods Get and Output has 3rd parameter "OnCacheHit" where you can put code block (closure) that should be executed if content is returned from cache (meaning main closure was not executed).

Example for use case using this feature can be caching template block containing ContactForm7 shortcode because beside echoing HTML this plugin relies on actions to include some javascript. Using 3rd parameter you can execute all that side-effects to simulate normal environment and ensure plugin proper operation, in this case: echoing missing javascript code.

MVC themes

This library is perfect for MVC style themes, you can wrap all getters from "model" with closure and fetch them via Get() method, just like in last usage example. Pure simplicity: gather all data from all sources and cache them in single call.

Security issues

If you have found a security issue, please contact the author directly at office@tekod.com.