$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, $beautify = false, int $maxLength = 2048);

Arguments

NameType(s)Description
valuestring

Value to sanitize

beautify (optional)bool, int

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=2048)

Return value

string

Sanitized path name

$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.214

Twitter updates

  • This week ProcessWire 3.0.214 is on the dev branch. Relative to 3.0.213 this version has 16 new commits which include the addition of 3 new pull requests, 6 issue fixes, a new WireNumberTools utility class, and various other improvements. More
    17 March 2023
  • ProcessWire 3.0.213 core updates: This week we’ll look at the new WireSitemapXML module, a new WireNumberTools core class, and a new ability for Fieldtype modules to specify useful ready-to-use configurations when creating new fields. More
    24 February 2023
  • ProcessWire 3.0.212 core updates— More
    17 February 2023

Newest forum posts

Latest news

  • ProcessWire Weekly #462
    In the 462nd issue of ProcessWire Weekly we'll cover the latest core updates, check out a new third party module called Template Access Log, and more. Read on!
    Weekly.pw / 18 March 2023
  • ProcessWire 3.0.213 core updates
    This week we’ll look at the new WireSitemapXML module, a new WireNumberTools core class, and a new ability for Fieldtype modules to specify useful ready-to-use configurations when creating new fields.
    Blog / 24 February 2023
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani