Clear only URL segment(s) for page (optionally specifying which ones)
Usage
// basic usage
$int = $proCacheStatic->clearPageUrlSegments(Page $page);
// usage with all arguments
$int = $proCacheStatic->clearPageUrlSegments(Page $page, $urlSegments = true, array $options = []);
Arguments
| Name | Type(s) | Description |
|---|
page | Page | |
urlSegments (optional) | string, array, bool | Specify any one of the following: - Boolean true to clear all URL segments (default behavior if not specified)
- String with 'segment1' or 'segment1/segment2' or 'segment1/segment2/segment3', etc.
- String with wildcard to clear all matching wildcard, i.e. 'boat-' or 'boats/boat-' or '-boat' or 'boat*'
- String with PCRE regular expression to match
- Array of URL segments (strings) to clear
|
options (optional) | array | 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.244