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

Twitter updates

  • Weekly update, July 29: Continuing upgrades to ProcessWire’s comments system and FormBuilder, along with a working example—More
    29 July 2022
  • Weekly update for July 22– Looking back at what web development was like in the year 2000. Plus some more discussion on the path from CKEditor 4 to CkEditor 5 in ProcessWire: More
    22 July 2022
  • ProcessWire 3.0.203 core updates: new support for custom fields on comments and more— More
    15 July 2022

Latest news

  • ProcessWire Weekly #429
    In the 429th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a new third party module, and more. Read on!
    Weekly.pw / 30 July 2022
  • Debugging tools built into ProcessWire
    ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them.
    Blog / 1 July 2022
  • Subscribe to weekly ProcessWire news

“Indeed, if ProcessWire can be considered as a CMS in its own right, it also offers all the advantages of a CMF (Content Management Framework). Unlike other solutions, the programmer is not forced to follow the proposed model and can integrate his/her ways of doing things.” —Guy Verville, Spiria Digital Inc.