$sanitizer→word()

Return first word in given string

Available since version 3.0.162.

Usage

// basic usage
$string = $sanitizer->word(string $value);

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

Arguments

NameType(s)Description
$valuestring

String containing one or more words

$options (optional)array

Options to adjust behavior:

  • keepNumbers (bool): Allow numbers as 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 words Default:1 or 99 if a seperator option is specified
  • maxLength (int): Maximum returned string length Default:1024
  • stripTags (bool): Strip markup tags so they don’t contribute to returned word? Default:true
  • `separator' (string): Merge multiple words into one word split by this character? Default:'', disabled 3.0.195+
  • ascii (bool): Allow only ASCII word characters? Default:false
  • beautify (bool): Make ugly strings more pretty? This collapses and trims redundant separators Default:false

Return value

string

See Also

$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.251