$sanitizer->name() method

Sanitize in "name" format (ASCII alphanumeric letters/digits, hyphens, underscores, periods)

Default behavior:

  • Allows both upper and lowercase ASCII letters.
  • Limits maximum length to 128 characters.
  • Replaces non-name format characters with underscore "_".

Example

$test = "Foo+Bar Baz-123"
echo $sanitizer->name($test); // outputs: Foo_Bar_Baz-123

Usage

// basic usage
$string = $sanitizer->name(string $value);

// usage with all arguments
$string = $sanitizer->name(string $value, $beautify = false, int $maxLength = 128, string $replacement = '_', array $options = []);

Arguments

NameType(s)Description
valuestring

Value that you want to convert to name format.

beautify (optional)bool, int

Beautify the returned name?

  • Beautify makes returned name prettier by getting rid of doubled punctuation, leading/trailing punctuation and such.
  • Should be TRUE when creating a resource using the name for the first time (default is FALSE).
  • You may also specify the constant Sanitizer::translate (or integer 2) for the this argument, which will make it translate letters based on name format settings in ProcessWire.
maxLength (optional)int

Maximum number of characters allowed in the name (default=128).

replacement (optional)string

Replacement character for invalid characters. Should be either "", "-" or "." (default="").

options (optional)array

Extra options to replace default 'beautify' behaviors

  • allowAdjacentExtras (bool): Whether to allow [-_.] characters next to each other (default=false).
  • allowDoubledReplacement (bool): Whether to allow two of the same replacement chars [-_] next to each other (default=false).
  • allowedExtras (array): Specify extra allowed characters (default=['-', '_', '.']`).

Return value

string

Sanitized value in name format

See Also


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.137

Twitter updates

  • New post: An introductory look at ProcessWire LoginRegisterPro, a module for providing new user registration, secure logins, profile editing, and more— More
    13 December 2019
  • 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

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
  • Login Register Pro
    This week we’ll take a look at LoginRegisterPro — a new module that provides an all-in-one, self contained module for providing new user registration, secure logins, profile editing, and more. It does this all in a manner that is reliable, efficient, comprehensive and secure.
    Blog / 13 December 2019
  • 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