$sanitizer->chars() method

Sanitize string value to have only the given characters

You must provide a string of allowed characters in the $allow argument. If not provided then the only [ a-z A-Z 0-9 ] are allowed. You may optionally specify [alpha] to refer to any ASCII alphabet character, or [digit] to refer to any digit.

Available since version 3.0.126.

Example

echo $sanitizer->chars('foo123barBaz456', 'barz1'); // Outputs: 1baraz
echo $sanitizer->chars('(800) 555-1234', '[digit]', '.');  // Outputs: 800.555.1234
echo $sanitizer->chars('Decatur, GA 30030', '[alpha]', '-'); // Outputs: Decatur-GA
echo $sanitizer->chars('Decatur, GA 30030', '[alpha][digit]', '-'); // Outputs: Decatur-GA-30030

Usage

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

// usage with all arguments
$string = $sanitizer->chars(string $value, $allow = '', string $replacement = '', bool $collapse = true, $mb = null);

Arguments

NameType(s)Description
valuestring

Value to sanitize

allow (optional)string, array

Allowed characters string. If omitted then only alphanumeric [ a-z A-Z 0-9 ] are allowed. Use shortcut [alpha] to refer to any “a-z A-Z” char or [digit] to refer to any digit.

replacement (optional)string

Replace disallowed chars with this char or string, or omit for blank. (default='')

collapse (optional)bool

Collapse multiple $replacement chars to one and trim from return value? (default=true)

mb (optional)bool, null

Specify bool to force use of multibyte on or off, or omit to auto-detect. (default=null)

Return value

string


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.209

Twitter updates

  • Adding custom actions to ProcessWire image fields in the admin, part of this week’s dev branch additions: More
    27 January 2023
  • ProcessWire 3.0.210 new main/master version released— More
    6 January 2023
  • ProcessWire 3.0.209: Core updates and an interesting AI that knows ProcessWire– More
    30 December 2022

Latest news

  • ProcessWire Weekly #455
    In the 455th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new third party module called JkPublishPages, and more. Read on!
    Weekly.pw / 28 January 2023
  • ProcessWire 3.0.210 new main/master version
    140 commits, 55 resolved issues, dozens of new features, eight contributors, and five new pull requests make yet another great new version of ProcessWire.
    Blog / 6 January 2023
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.