Sanitize a string or array containing multiple names
- Default behavior is to sanitize to ASCII alphanumeric and hyphen, underscore, and period.
- If given a string, multiple names may be separated by a delimeter (which is a space by default).
- Return value will be of the same type as the given value (i.e. string or array).
Usage
// basic usage
$string = $sanitizer->names($value);
// usage with all arguments
$string = $sanitizer->names($value, string $delimeter = ' ', array $allowedExtras = [], string $replacementChar = '_', bool $beautify = false);Arguments
| Name | Type(s) | Description |
|---|---|---|
value | string, array | Value(s) to sanitize to name format. |
delimeter (optional) | string | Character that delimits values, if $value is a string (default=" "). |
allowedExtras (optional) | array | Additional characters that are allowed in the value (default=['-', '_', '.']). |
replacementChar (optional) | string | Single character replacement value for invalid characters (default='_'). |
beautify (optional) | bool | Whether or not to beautify returned values (default=false). See Sanitizer::name() for beautify options. |
Return value
string arrayReturns string if given a string for $value, returns array if given an array for $value.
$sanitizer methods and properties
API reference based on ProcessWire core version 3.0.244