$sanitizer→path()
Validate the given path, return path if valid, or false if not valid
Returns the given path if valid, or boolean false if not.
Path is validated per ProcessWire "name" convention of ascii only [-_./a-z0-9] As a result, this function is primarily useful for validating ProcessWire paths, and won't always work with paths outside ProcessWire.
This method validates only and does not sanitize. See $sanitizer->pagePathName() for a similar
method that does sanitiation.
Usage
// basic usage
$bool = $sanitizer->path(string $value);
// usage with all arguments
$bool = $sanitizer->path(string $value, $options = []);Arguments
| Name | Type(s) | Description |
|---|---|---|
$value | string | Path to validate |
$options (optional) | int array | Options to modify behavior, or maxLength (int) may be specified.
|
Return value
bool stringReturns false if invalid, actual path (string) if valid.
See Also
$sanitizer methods and properties
API reference based on ProcessWire core version 3.0.251