PagesLoaderCache::cacher method

Remove all pages from the cache

3.0.259 Deprecated 2nd argument (previously $options) and moved to 1st argument but still backwards compatible.

Usage

// basic usage
$int = $pages->cacher->uncacheAll();

// usage with all arguments
$int = $pages->cacher->uncacheAll($options = [], $deprecated = null);

Arguments

Name Type(s) Description

Name	Type(s)	Description
`$options` (optional)	`array` `Page`	Options to modify default behavior or Page object for 'page' option: `shallow` (bool): By default, this method also calls $page->uncache(). To prevent that call, set this to true. `page` (Page): Optionally specify Page instance that initiated the call (for debugging purposes only).
`$deprecated` (optional)	`array` `null`	Old location of $options, now deprecated, but still supported for backwards compatibility.

$options (optional)

array Page

Options to modify default behavior or Page object for 'page' option:

shallow (bool): By default, this method also calls $page->uncache(). To prevent that call, set this to true.
page (Page): Optionally specify Page instance that initiated the call (for debugging purposes only).

$deprecated (optional)

array null

Old location of $options, now deprecated, but still supported for backwards compatibility.

Return value

int

Number of pages uncached

$pages->cacher methods and properties

API reference based on ProcessWire core version 3.0.261