$sanitizer→wordsArray()

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
  • truncate (bool): Truncate rather than remove words that exceed maxWordLength? Default:false 3.0.250+

Return value

array

$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.251