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

Latest news

  • ProcessWire Weekly #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 December 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK