WireTextTools::collapse() method

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


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

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



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

Twitter updates

  • ProcessWire 3.0.161 adds support for selector operator stacking, enabling you automatically broaden searches in a single pages.find() call— More
    26 June 2020
  • ProcessWire 3.0.160 adds powerful new text-searching operators, bringing a new level of power to page-finding API calls, especially when it comes to search engine type queries. Post also includes a demo search engine where you can test it all out live— More
    19 June 2020
  • Preview of ProcessWire 3.0.160 with auto-enable of two-factor authentication, new version of TfaEmail and TfaTotp, and new selector operators coming next week. More
    12 June 2020

Latest news

  • ProcessWire Weekly #320
    In the 320th issue of ProcessWire Weekly we're going to check out the latest core updates (ProcessWire 3.0.161), a new third party module called Fieldtype Runtime only, an IndieWeb themed article from Francesco Schwarz, and more. Read on!
    Weekly.pw / 27 June 2020
  • Powerful new text-searching abilities in 3.0.160
    In ProcessWire 3.0.160 we’ve got some major upgrades and additions to our text-search abilities. This brings a whole new level of power to $pages->find() and similar API calls, especially when it comes to search engine type queries.
    Blog / 19 June 2020
  • 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