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

Latest news

  • ProcessWire Weekly #553
    In the 553rd issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module called Text Synthesis, and more. Read on!
    Weekly.pw / 14 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

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK