PageRender::getCacheFile()

Get a CacheFile object corresponding to this Page

Note that this does not check if the page is cachable. This is so that if a cachable setting changes the cache can still be removed.

Usage

// basic usage
$cacheFile = $pageRender->getCacheFile($page);

// usage with all arguments
$cacheFile = $pageRender->getCacheFile($page, array $options = []);

Arguments

NameType(s)Description
$pageint Page

May provide page id (int) only if using for deleting a cache file. Must provide Page object otherwise.

$options (optional)array

Return value

CacheFile

Exceptions

Method can throw exceptions on error:

  • WireException

PageRender methods and properties

API reference based on ProcessWire core version 3.0.253