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

Twitter updates

  • ProcessWire 3.0.133 adds a useful new Page::meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type— More
    14 June 2019
  • New post: This week we’ll take a look at 3 different WEBP image strategies that you can use in ProcessWire 3.0.132+. Then we’ll dive into a major update for the Google Client API module, and finish up by outlining some useful new updates in FormBuilder— More
    31 May 2019
  • New post: This week we've added WEBP support in ProcessWire thanks to a GitHub pull request from Horst Nogajski. This enables you to have highly optimized image output in PW and I think you’ll really like the difference it makes— More
    24 May 2019

Latest news

  • ProcessWire Weekly #266
    In the 266th issue of ProcessWire Weekly we're going to take a closer look at ProcessWire 3.0.133 (dev), introduce a third party module called Repeater Images, and highlight a recently released site belonging to the Australian Antarctic Division. Read on!
    Weekly.pw / 15 June 2019
  • ProcessWire 3.0.133 core updates
    ProcessWire 3.0.133 adds a useful new $page->meta() method for a new type of page-specific persistent data storage, adds the ability for users to create their own bookmarks in Lister, and has a handy and time saving update for the asmSelect input type. Read on for all the details, examples and screenshots.
    Blog / 14 June 2019
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer