$procachehasCacheFile()

Get cache file for given Page (and options) or false if does not currently have a cache file

Usage

// basic usage
$bool = $procache->hasCacheFile(Page $page);

// usage with all arguments
$bool = $procache->hasCacheFile(Page $page, array $options = []);

Arguments

NameType(s)Description
$pagePage

Page to check or get cache file info for

$options (optional)array

Options to refine request:

  • getFile (bool): Specify true to return the filename whether it exists or not Default:false
  • 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.
  • 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): Optionally specify URL segments here as "seg1/seg2/etc" as alternative to above.

Return value

bool string

Returns false if not cached, or returns string with cache filename if cached.


$procache methods and properties

API reference based on ProcessWire core version 3.0.252