$sanitizer->words() method

Given string return a new string containing only words

Available since version 3.0.195.

Usage

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

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

Arguments

NameType(s)Description
value
options (optional)array
  • separator (string): String to use to separate words (default=' ')
  • ascii (string): Only allow ASCII characters in words? (default=false)
  • keepUnderscore (bool): Keep underscores as part of words? (default=false)
  • keepHyphen (bool): Keep hyphenated words? (default=false)
  • keepChars (array): Additional non word characters to keep (default=[])
  • maxWordLength (int): Maximum word length (default=80)
  • minWordLength (int): Minimum word length (default=1)
  • maxLength (int): Maximum return value length (default=1024)
  • beautify (bool): Make ugly strings more pretty? This collapses and trims redundant separators (default=true)

Return value

string


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #523
    In the 523rd issue of ProcessWire Weekly we'll check out what's new in the core this week, share some new module related news, and more. Read on!
    Weekly.pw / 18 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“We chose ProcessWire because of its excellent architecture, modular extensibility and the internal API. The CMS offers the necessary flexibility and performance for such a complex website like superbude.de. ProcessWire offers options that are only available for larger systems, such as Drupal, and allows a much slimmer development process.” —xport communication GmbH