$sanitizer->words() method

Given string return a new string containing only words

Available since version 3.0.195.


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

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


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


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.228

Latest news

  • ProcessWire Weekly #489
    In the 489th issue of ProcessWire Weekly we'll check out what's new in the core this week, share a brand-new recipe of the week, and more. Read on!
    Weekly.pw / 23 September 2023
  • ProcessWire 3.0.226 new main/master version
    After 8 months in development we are excited to bring you ProcessWire 3.0.226 main/master. This version has a ton of great new features, improvements and optimizations, plus more than 100 issue fixes. This post takes an in-depth look at highlights from this great new version.
    Blog / 25 August 2023
  • 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