Clear page pagination(s)
Usage
// basic usage
$int = $proCacheStatic->clearPageNum(Page $page);
// usage with all arguments
$int = $proCacheStatic->clearPageNum(Page $page, $pageNum = true, array $options = []);
Arguments
| Name | Type(s) | Description |
|---|
page | Page | |
pageNum (optional) | bool, int | Specify one of the following: - Integer (greater than 1) of pagination number to clear.
- Boolean true to clear all paginations greater than 1.
|
options (optional) | array | urlSegments (array|bool): Specify URL segments to use, true to clear only URL segments, false to exclude any URL segments, or omit (blank array) to allow inclusion of any URL segments. language (string|int|Language|bool): Clear only this language (default='')pageNum (bool): Specify boolean true to also clear pagination URL segments (default=false)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 arrayQuantity or array of files and/or directories that were removed
ProCacheStatic methods and properties
API reference based on ProcessWire core version 3.0.236