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

Latest news

  • ProcessWire Weekly #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer