WireTextTools::collapse() method

Collapse string to plain text that all exists on a single long line without destroying words/punctuation.

Usage

// basic usage
$string = $wireTextTools->collapse(string $str);

// usage with all arguments
$string = $wireTextTools->collapse(string $str, array $options = []);

Arguments

NameType(s)Description
strstring

String to collapse

options (optional)array
  • stripTags (bool): Strip markup tags? (default=true)
  • keepTags (array): Array of tag names to keep, if stripTags==true. (default=[])
  • collapseLinesWith (string): String to collapse newlines with. (default=' ')
  • linksToUrls (bool): Convert links to "(url)" rather than removing entirely? (default=false) Since 3.0.132
  • endBlocksWith (string): Character or string to insert to identify paragraph/header separation (default='')
  • convertEntities (bool): Convert entity-encoded characters to text? (default=true)

Return value

string

WireTextTools methods and properties

API reference based on ProcessWire core version 3.0.244

“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