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

Twitter updates

  • Quick weekly update covering this week's commits for the upcoming 3.0.167 ProcessWire core version— More
    18 September 2020
  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020
  • Weekly update – 28 August 2020 – New secure files option defined per-template: More
    28 August 2020

Latest news

  • ProcessWire Weekly #331
    In the 331st issue of ProcessWire Weekly we're going to check out the latest core and Pro module updates (ProcessWire 3.0.166, ProCache 4.0.1, and Form Builder v44), introduce the Wireframe API module, and more. Read on!
    Weekly.pw / 12 September 2020
  • ProcessWire 3.0.166 core updates and more
    This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder.
    Blog / 11 September 2020
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.