$sanitizer->wordsArray() method

Return array of all words in given value (excluding punctuation and other non-word characters)

Available since version 3.0.160.

Usage

// basic usage
$array = $sanitizer->wordsArray($value);

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

Arguments

NameType(s)Description
valuestring, array

String containing words

options (optional)array
  • keepNumbers (bool): Keep number-only words in return value? (default=true)
  • keepNumberFormat (bool): Keep minus/comma/period in numbers rather than splitting into words? Also requires keepNumbers==true. (default=false)
  • keepUnderscore (bool): Keep underscores as part of words? (default=false)
  • keepHyphen (bool): Keep hyphenated words? (default=false)
  • keepApostrophe (bool): Keep apostrophe as part of words? (default=true) 3.0.168+
  • keepChars (array): Specify any of these to also keep as part of words ['.', ',', ';', '/', '*', ':', '+', '<', '>', '_', '-' ] (default=[])
  • minWordLength (int): Minimum word length (default=1)
  • maxWordLength (int): Maximum word length (default=80)
  • maxWords (int): Maximum number of words allowed (default=0, no limit)
  • stripTags (bool): Strip markup tags so they don’t contribute to returned word list? (default=true)

Return value

array


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.185

Twitter updates

  • ProcessWire 3.0.192 (dev branch) contains 11 issue fixes and 5 pull requests, over 20 commits— More
    7 January 2022
  • ProcessWire 3.0.191 core updates: updates to the installer and the profile exporter module— More
    24 December 2021
  • This week ProcessWire went on a diet, trimming the core size from 15.5 MB down to 7.5 MB by moving optional site profiles into their own GitHub repos— More
    17 December 2021

Latest news

  • ProcessWire Weekly #401
    In the 401st issue of ProcessWire Weekly we'll cover the latest core updates, check out a brand new module called Lister Native Date Format, and more. Read on!
    Weekly.pw / 15 January 2022
  • ProcessWire 3.0.190 core updates
    ProcessWire 3.0.190 has 15 commits relative to 3.0.189 and contains a mixture of issue resolutions and feature additions. This post covers them all, in addition to updates for the PageAutosave and ProFields Table modules.
    Blog / 3 December 2021
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer