$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)
    • 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.163

Twitter updates

  • ProcessWire 3.0.163 resolves more than a dozen issue reports and adds new hooks and configurable module install options, among numerous other updates. In addition, a major update to ProCache (v4.0) has been released— More
    24 July 2020
  • Weekly update for 17 July 2020 and a look at new features coming in next week's version of ProCache— More
    17 July 2020
  • ProcessWire 3.0.162 continues improvements to selector operators, fixes various minor issues, adds new API convenience methods, improves documentation, optimizes and refactors various portions of code and DB queries, and more— More
    10 July 2020

Latest news

  • ProcessWire Weekly #325
    In the 325th issue of ProcessWire Weekly we're going to cover a new master version of ProcessWire, introduce the Textformatter Audio Embed module, and more. Read on!
    Weekly.pw / 1 August 2020
  • Powerful new text-searching abilities in 3.0.160
    In ProcessWire 3.0.160 we’ve got some major upgrades and additions to our text-search abilities. This brings a whole new level of power to $pages->find() and similar API calls, especially when it comes to search engine type queries.
    Blog / 19 June 2020
  • 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.