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

Twitter updates

  • This week ProcessWire 3.0.214 is on the dev branch. Relative to 3.0.213 this version has 16 new commits which include the addition of 3 new pull requests, 6 issue fixes, a new WireNumberTools utility class, and various other improvements. More
    17 March 2023
  • ProcessWire 3.0.213 core updates: This week we’ll look at the new WireSitemapXML module, a new WireNumberTools core class, and a new ability for Fieldtype modules to specify useful ready-to-use configurations when creating new fields. More
    24 February 2023
  • ProcessWire 3.0.212 core updates— More
    17 February 2023

Latest news

  • ProcessWire Weekly #462
    In the 462nd issue of ProcessWire Weekly we'll cover the latest core updates, check out a new third party module called Template Access Log, and more. Read on!
    Weekly.pw / 18 March 2023
  • ProcessWire 3.0.213 core updates
    This week we’ll look at the new WireSitemapXML module, a new WireNumberTools core class, and a new ability for Fieldtype modules to specify useful ready-to-use configurations when creating new fields.
    Blog / 24 February 2023
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer