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

Twitter updates

  • New main/master version of ProcessWire that has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release— More
    13 May 2022
  • Summary of weekly core updates for 22 April 2022 More
    22 April 2022
  • ProcessWire 3.0.198 core updates: in this post we take a closer look at 3 useful new features added in this version— More
    15 April 2022

Latest news

  • ProcessWire Weekly #418
    In the 418th issue of ProcessWire Weekly we'll cover recent highlights, share some tips and tricks, and check out the new master version of ProcessWire, 3.0.200. Read on!
    Weekly.pw / 14 May 2022
  • ProcessWire 3.0.200 new master/main version
    This new main/master version has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release. This post covers all the details.
    Blog / 13 May 2022
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH