$sanitizer->sanitize() method

Call a sanitizer method indirectly where method name can contain combined/combo methods

This method is primarily here to support predefined sanitizers in strings, like those that might be specified in settings for a module or field. For regular use, you probably want to call the sanitizer methods directly rather than through this method.

Available since version 3.0.125.

Example

// sanitize with text then entities sanitizers
$value = $sanitizer->sanitize($value, 'text,entities');

// numbers appended to text sanitizers imply max length
$value = $sanitizer->sanitize($value, 'text128,entities'); 

Usage

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

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

Arguments

NameType(s)Description
valuemixed
method (optional)string

Method name "method", or combined method name(s) "method1,method2,method3"

Return value

string int array float null


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer