Clear entire cache
Usage
$int = $procache->clearAll();
Return value
int
Quantity of items cleared
Hooking $procache->clearAll()
You can add your own hook events that are executed either before or after the $procache
method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.
Hooking before
The 'before' hooks are called immediately before each $procache
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('ProCache::clearAll', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$procache = $event->object;
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
});
Hooking after
The 'after' hooks are called immediately after each $procache
method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('ProCache::clearAll', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$procache = $event->object;
// An 'after' hook can retrieve and/or modify the return value
$return = $event->return;
/* Your code here, perhaps modifying the return value */
// Populate back return value, if you have modified it
$event->return = $return;
});
$procache methods and properties
API reference based on ProcessWire core version 3.0.236