$sanitizer->names() method

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

NameType(s)Description
valuestring, 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 array

Returns 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.200

Twitter updates

  • New TinyMCE 6.2.0 Inputfield released for ProcessWire— More
    28 October 2022
  • This week we take a look at a new rich text editor for ProcessWire, why we chose it, some highlights, screenshots, and why we think you’ll like it— More
    21 October 2022
  • This week we have ProcessWire 3.0.206 on the dev branch and a new version of the ProDevTools UserActivity module, which we'll take a closer look at in this post— More
    7 October 2022

Latest news

  • ProcessWire Weekly #445
    In the 445th issue of ProcessWire Weekly we're going to check out the latest core updates, the latest weekly update from Ryan, new third party module called InlineCompleteTinyMCE, and more. Read on!
    Weekly.pw / 20 November 2022
  • New rich text editor for ProcessWire
    This week we take a look at a new rich text editor for ProcessWire, why we chose it, some highlights, screenshots, and why we think you’ll like it.
    Blog / 21 October 2022
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK