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

Twitter updates

  • There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new—More
    20 November 2020
  • ProcessWire 3.0.168 core updates — More
    26 October 2020
  • This week a 2nd new module for processing Stripe payments has been added to FormBuilder. Unlike our other Stripe Inputfield, this new one supports 3D Secure (SCA) payments. We’ll take a closer look at it in this post, plus a live demo— More
    16 October 2020

Latest news

  • ProcessWire Weekly #341
    In the 341st issue of ProcessWire Weekly we're going to check out the latest processwire.com blog post, introduce upcoming commercial module called NiftyPasswordsPlus, and check out a brand new site of the week. Read on!
    Weekly.pw / 21 November 2020
  • New ProcessWire modules directory
    There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new.
    Blog / 20 November 2020
  • 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