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

Twitter updates

  • We added WebP image support this year and many have been adopting it in existing projects. We look at a process used for migrating existing websites to WebP images— from preliminary considerations to implementation & testing, w/lots of tips & tricks too: More
    16 August 2019
  • Core version 3.0.137 on the dev branch adds the ability to hook multiple methods at once, in a single call. This post details how it works and provides a useful example of how you might put it to use in your development environment— More
    2 August 2019
  • ProcessWire 3.0.136 updates our CKEditor version and adds a new backtrace() method to the core Debug class— More
    26 July 2019

Latest news

  • ProcessWire Weekly #275
    In the 275th issue of ProcessWire Weekly we're going to walk you through the new features included in ProcessWire 3.0.138, cover some WebP related stuff, and highlight recent forum posts and online resources. Read on!
    Weekly.pw / 17 August 2019
  • WebP images on an existing site
    In this post we’ll look at a process used for migrating an existing website to use WebP images. We’ll cover everything from preliminary considerations to implementation and testing, with lots of tips and tricks along the way.
    Blog / 16 August 2019
  • 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