$sanitizer->validate() method

Validate that value remains unchanged by given sanitizer method, or return null if not

If change is just a type conversion change or surrounding whitespace (that gets trimmed) then this is still considered valid.

Returns NULL or given $fallback value if value does not validate. Note that if results like 0, false or blank string are considered valid values, then this method can return them. So for cases like that you should compare the return value with NULL (or whatever your $fallback is).

things like 0 or false (if that is a valid value) compare the return value with null before assuming a value is not valid.

Available since version 3.0.125.

Example

$sanitizer->validate('abc', 'alpha'); // valid: returns 'abc'
$sanitizer->validate('abc123', 'alpha'); invalid: returns null

Usage

// basic usage
$mixed = $sanitizer->validate($value);

// usage with all arguments
$mixed = $sanitizer->validate($value, string $method = 'text', $fallback = null);

Arguments

NameType(s)Description
valuestring, int, array, float

Value to validate

method (optional)string

Saniatizer method name or CSV names combo

fallback (optional)

Return value

null mixed

Returns sanitized value if it validates or null (or given fallback) if value does not validate


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.185

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #388
    In the 388th issue of ProcessWire Weekly we'll check out the latest core update, introduce two new third party modules, and more. Read on!
    Weekly.pw / 16 October 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • 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