$sanitizer->path() method

Validate the given path, return path if valid, or false if not valid

Returns the given path if valid, or boolean false if not.

Path is validated per ProcessWire "name" convention of ascii only [-_./a-z0-9] As a result, this function is primarily useful for validating ProcessWire paths, and won't always work with paths outside ProcessWire.

This method validates only and does not sanitize. See $sanitizer->pagePathName() for a similar method that does sanitiation.

Usage

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

// usage with all arguments
$bool = $sanitizer->path(string $value, $options = []);

Arguments

NameType(s)Description
valuestring

Path to validate

options (optional)int, array

Options to modify behavior, or maxLength (int) may be specified.

  • allowDotDot (bool): Whether to allow ".." in a path (default=false)
  • maxLength (int): Maximum length of allowed path (default=1024)

Return value

bool string

Returns false if invalid, actual path (string) if valid.

See Also


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.130

Twitter updates

  • New post: Quietly and without interruption this week, the ProcessWire.com website (and all subdomains) moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before— More
    19 April 2019
  • New post: With ProcessWire 3.0.130, this week we’ll take a detailed look at a few useful new API additions made in the last few weeks, along with examples of each—More
    12 April 2019
  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019

Latest news

  • ProcessWire Weekly #258
    In the 258th issue of ProcessWire Weekly we'll cover a hosting upgrade for the processwire.com site and it's subdomains, introduce PW Review and Terminal module, and feature the new site of O'Neil Cinema. Read on!
    Weekly.pw / 20 April 2019
  • ProcessWire.com website hosting upgrades
    Quietly and without interruption this week, our whole website moved from a single static server to a load-balanced multi-server environment, giving us even more horsepower and redundancy than before.
    Blog / 19 April 2019
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits