$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.200

Twitter updates

  • A review of weekly core updates, plus a simple recipe for a very effective listing cache—More
    24 June 2022
  • Weekly update: Making ProcessWire render pages at old WordPress URLs (or building a simple/custom URL router in PW): More
    17 June 2022
  • New post: ProcessWire now comes with just 1 site installation profile, the "blank" profile. It makes very few assumptions, making it a minimal though excellent starting point. Here’s how you might use it— More
    10 June 2022

Latest news

  • ProcessWire Weekly #424
    In the 424th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module, and more. Read on!
    Weekly.pw / 25 June 2022
  • Starting a site with the “blank” profile
    ProcessWire 3.0.200+ comes with just 1 site installation profile, the site-blank profile. This profile makes very few assumptions, making it a minimal though excellent starting point. Here’s how you might use it. 
    Blog / 10 June 2022
  • Subscribe to weekly ProcessWire news

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