$sanitizer->pagePathName() method

Sanitize a page path name

Returned path is not guaranteed to be valid or match a page, just sanitized.

Usage

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

// usage with all arguments
$string = $sanitizer->pagePathName(string $value, bool $beautify = false, int $maxLength = 1024);

Arguments

NameType(s)Description
valuestring

Value to sanitize

beautify (optional)bool

Beautify the value? (default=false). Maybe any of the following:

  • true (bool): Beautify the individual page names in the path to remove redundant and trailing punctuation and more.
  • false (bool): Do not perform any conversion or attempt to make it more pretty, just sanitize (default).
  • Sanitizer::translate (constant): Translate UTF-8 characters to visually similar ASCII (using InputfieldPageName module settings).
  • Sanitizer::toAscii (constant): Convert UTF-8 characters to punycode ASCII.
  • Sanitizer::toUTF8 (constant): Convert punycode ASCII to UTF-8.
  • Sanitizer::okUTF8 (constant): Allow UTF-8 characters to appear in path (implied if $config->pageNameCharset is 'UTF8').
maxLength (optional)int

Maximum length (default=1024)

Return value

string

Sanitized path name


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.163

Twitter updates

  • Weekly update – 28 August 2020 – New secure files option defined per-template: More
    28 August 2020
  • ProcessWire 3.0.165 core updates (master and dev branch) and reCAPTCHA for FormBuilder module— More
    21 August 2020
  • What's coming in ProcessWire 3.0.165, plus a brief preview ProCache and FormBuilder versions coming within the next couple of weeks— More
    14 August 2020

Latest news

  • ProcessWire Weekly #330
    In the 330th issue of ProcessWire Weekly we'll take a quick peek at the new release of the FormBuilder module, cover some recent form highlights, and more. Read on!
    Weekly.pw / 5 September 2020
  • ProcessWire 3.0.164 new master version
    This week we’re proud to announce the newest ProcessWire master version 3.0.164. Relative to the previous master version (3.0.148) this version adds a ton of new and useful features and fixes more than 85 issues, with more than 225 commits over a period of 7 months.
    Blog / 7 August 2020
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull