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

Latest news

  • ProcessWire Weekly #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 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.