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

Twitter updates

  • ProcessWire 3.0.146 on the dev branch contains about 22 commits with a combination of useful upgrades and issue report resolutions, more details in this forum post: More
    22 November 2019
  • ProcessWire 3.0.144 and 3.0.145 add improved field template context override settings and include a new Inputfields API, along with numerous other issue fixes, optimizations and improvements to the core. More
    8 November 2019
  • ProcessWire 3.0.144 core updates: Upgraded overrides section in the field editor, a new Inputfields JS API, and more— More
    1 November 2019

Latest news

  • ProcessWire Weekly #291
    In the 291st issue of ProcessWire Weekly we're going to take a closer look at the latest core updates, check out a brand new third party module called ProcessHelpVideos, and introduce a new site of the week. Read on!
    Weekly.pw / 8 December 2019
  • New User Activity module
    Blog / 29 November 2019
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits