$procache->allowCacheForPage() method

Hookable method to allow custom rules to determine if page output should be saved to cache file for this request

Note this method does not indicate if the page is cacheable, only if a cached file should be saved for this request. Meaning, this will always be false when a user is logged in.

Usage

$bool = $procache->allowCacheForPage(Page $page);

Arguments

NameType(s)Description
pagePage

Return value

bool


Hooking $procache->allowCacheForPage(…)

You can add your own hook events that are executed either before or after the $procache->allowCacheForPage(…) 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->allowCacheForPage(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('ProCache::allowCacheForPage', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $procache = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $page = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $page);
});

Hooking after

The 'after' hooks are called immediately after each $procache->allowCacheForPage(…) 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::allowCacheForPage', 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;

  // Get values of arguments sent to hook (if needed)
  $page = $event->arguments(0);

  /* 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.244

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer