$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.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #388
    In the 388th issue of ProcessWire Weekly we'll check out the latest core update, introduce two new third party modules, and more. Read on!
    Weekly.pw / 16 October 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer