$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 #551
    In the 551st issue of ProcessWire Weekly we'll check out what's new in the core this week, share a new weekly poll, and more. Read on!
    Weekly.pw / 1 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

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