ProCacheStatic::getCacheFile() method

Get cache file for given Page and options

Usage

// basic usage
$string = $proCacheStatic->getCacheFile(Page $page);

// usage with all arguments
$string = $proCacheStatic->getCacheFile(Page $page, array $options = []);

Arguments

NameType(s)Description
pagePage
options (optional)array
  • ext (string): File extension (omit to determine automatically).
  • host (string): Hostname or omit for current hostname
  • https (bool|null): True for HTTPS-only file, false for HTTP-only file, or omit for current scheme.
  • create (bool): Create dirs if they don't exist? (default=false)
  • pageNum (int): Pagination number or omit for first pagination or pagination not applicable.
  • language (Language|string|int|null): Language or omit for current language or if not applicable.
  • urlSegments (array): URL segments to include or omit if not applicable.
  • urlSegmentStr (string): Alternative to URL segments array, option to specify as string

Return value

string


ProCacheStatic methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH