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

Twitter updates

  • ProcessWire 3.0.142 has a lot of updates but the biggest is the addition of custom fields support for file and image fields. In this post, we take a closer look at that, and also outline all of the new features in the just-released FormBuilder v40— More
    11 October 2019
  • This week’s dev branch version brings you improvements to ProcessWire’s input->cookie API variable, plus it adds the ability to modify system URLs and paths at runtime. This post also includes some examples to demonstrate just how useful this can be— More
    20 September 2019
  • New post: This week we’ll take a look at a new version of FormBuilder that's on the way (with a screencast), as well as the latest version of the core: ProcessWire 3.0.140— More
    6 September 2019

Latest news

  • ProcessWire Weekly #283
    The 283rd issue of ProcessWire Weekly introduces ProcessWire 3.0.142 and FormBuilder v40, highlights some conference content, and features a new weekly poll continuing with the #processwireworks theme. Read on!
    Weekly.pw / 12 October 2019
  • ProcessWire 3.0.142 core updates
    This latest version of the core on the dev branch has a lot of updates, bnd the biggest is the addition of custom fields support for file and image fields. In this post, we take a closer look and also outline all of the new features in the just-released FormBuilder v40.
    Blog / 11 October 2019
  • 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