WireTextTools::collapse() method

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

Usage

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

// usage with all arguments
$mixed = $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

mixed string


WireTextTools methods and properties

API reference based on ProcessWire core version 3.0.172

Twitter updates

  • This week ProcessWire gained powerful new tools for finding pages and controlling how they are loaded. If you like to maximize performance and efficiency, you’ll like what 3.0.172 brings— More
    5 February 2021
  • ProcessWire 3.0.171 dev branch core updates – More
    22 January 2021
  • Preliminary 2021 roadmap in progress in this week’s update— More
    8 January 2021

Latest news

  • ProcessWire Weekly #354
    In the 354th issue of ProcessWire Weekly we're going to check out the latest core updates, properly introduce the ProcessCKInlineComplete module, and dig into a brand new site of the week. Read on!
    Weekly.pw / 20 February 2021
  • ProcessWire 3.0.172 – Find faster and more efficiently
    This week ProcessWire gained powerful new tools for finding pages and controlling how they are loaded. If you like to maximize performance and efficiency, you’ll like what 3.0.172 brings.
    Blog / 5 February 2021
  • Subscribe to weekly ProcessWire news

“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