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

Twitter updates

  • There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new—More
    20 November 2020
  • ProcessWire 3.0.168 core updates — More
    26 October 2020
  • This week a 2nd new module for processing Stripe payments has been added to FormBuilder. Unlike our other Stripe Inputfield, this new one supports 3D Secure (SCA) payments. We’ll take a closer look at it in this post, plus a live demo— More
    16 October 2020

Latest news

  • ProcessWire Weekly #341
    In the 341st issue of ProcessWire Weekly we're going to check out the latest processwire.com blog post, introduce upcoming commercial module called NiftyPasswordsPlus, and check out a brand new site of the week. Read on!
    Weekly.pw / 21 November 2020
  • New ProcessWire modules directory
    There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new.
    Blog / 20 November 2020
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH