$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.133

Twitter updates

  • ProcessWire 3.0.133 adds a useful new Page::meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type— More
    14 June 2019
  • New post: This week we’ll take a look at 3 different WEBP image strategies that you can use in ProcessWire 3.0.132+. Then we’ll dive into a major update for the Google Client API module, and finish up by outlining some useful new updates in FormBuilder— More
    31 May 2019
  • New post: This week we've added WEBP support in ProcessWire thanks to a GitHub pull request from Horst Nogajski. This enables you to have highly optimized image output in PW and I think you’ll really like the difference it makes— More
    24 May 2019

Latest news

  • ProcessWire Weekly #266
    In the 266th issue of ProcessWire Weekly we're going to take a closer look at ProcessWire 3.0.133 (dev), introduce a third party module called Repeater Images, and highlight a recently released site belonging to the Australian Antarctic Division. Read on!
    Weekly.pw / 15 June 2019
  • ProcessWire 3.0.133 core updates
    ProcessWire 3.0.133 adds a useful new $page->meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type. Read on for all the details, examples and screenshots.
    Blog / 14 June 2019
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer