$procache->clearPage() method

Clear the cache for a specific page, including pageNum and urlSegment versions

Usage

// basic usage
$int = $procache->clearPage(Page $page);

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

Arguments

NameType(s)Description
pagePage
options (optional)array
  • language (string|int|Language|bool): Clear only this language (default='')
  • urlSegmentStr (string): Clear only entries matching this URL segment string, wildcards OR regex OK (default='')
  • urlSegments (array|bool): Clear only entries having any of these URL segments, boolean false to clear no URL segments, omit (or empty array) to clear all (default=[])
  • pageNum (int|bool): Clear only pagination number (i.e. 2 or higher), true to clear all pageNum>1 false to clear no pageNum>1, omit (int 0) to clear all (default=0)
  • clearRoot (bool|null): Clear root index of page path? (default=false when specific URL segments or paginations requested, true otherwise)
  • rmdir (bool): Remove directories rather than index files? (default=false)
  • getFiles (bool): Get array of files that were cleared, rather than a count? (default=false)

Return value

int array

Quantity or array of files and/or directories that were removed


$procache methods and properties

API reference based on ProcessWire core version 3.0.244

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani