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

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #454
    In the 454th issue of ProcessWire Weekly we'll introduce a couple of brand new third party modules, check out what's new in the latest dev version of ProcessWire (3.0.211), and more. Read on!
    Weekly.pw / 21 January 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • 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.