$sanitizer->word() method

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.244

Latest news

  • ProcessWire Weekly #559
    The 559th issue of ProcessWire Weekly brings in all the latest news from the ProcessWire community. Modules, sites, and more. Read on!
    Weekly.pw / 25 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits