$sanitizer->words() method

Given string return a new string containing only words

Available since version 3.0.195.

Usage

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

// usage with all arguments
$string = $sanitizer->words($value, array $options = []);

Arguments

NameType(s)Description
value
options (optional)array
  • separator (string): String to use to separate words (default=' ')
  • ascii (string): Only allow ASCII characters in words? (default=false)
  • keepUnderscore (bool): Keep underscores as part of words? (default=false)
  • keepHyphen (bool): Keep hyphenated words? (default=false)
  • keepChars (array): Additional non word characters to keep (default=[])
  • maxWordLength (int): Maximum word length (default=80)
  • minWordLength (int): Minimum word length (default=1)
  • maxLength (int): Maximum return value length (default=1024)
  • beautify (bool): Make ugly strings more pretty? This collapses and trims redundant separators (default=true)

Return value

string


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #532
    In the 532nd issue of ProcessWire Weekly we'll cover the latest core updates, check out a couple of brand-new third party modules, and more. Read on!
    Weekly.pw / 20 July 2024
  • Page List Custom Children module
    This simple module gives you the ability to customize the parent/child relationship as it appears in the admin page list, enabling child pages to appear under more than one parent.
    Blog / 28 June 2024
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani