WireTextTools::markupToText()

Convert HTML markup to readable text

Like PHP’s strip_tags but with some small improvements in HTML-to-text conversion that improves the readability of the text.

In 3.0.197+ inner content of script, style and object tags is now removed, rather than just the tags. To revert this behavior or to remove content of additional tags, see the clearTags option.

Note that this method differs from the Sanitizer::markupToText() method in that this method is newer, more powerful and has more options. But the two methods differ in how they perform markup-to-text conversion so you may want to review and try both to determine which one better suits your needs.

Usage

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

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

Arguments

NameType(s)Description
$strstring

String to convert to text

$options (optional)array
  • keepTags (array): Tag names to keep in returned value, i.e. [ "em", "strong" ]. Default:none
  • clearTags (array): Tags that should also have their content cleared. Default:[ "script", "style", "object" ] 3.0.197
  • splitBlocks (string): String to split paragraph and header elements. Default:"\n\n"
  • convertEntities (bool): Convert HTML entities to plain text equivalents? Default:true
  • listItemPrefix (string): Prefix for converted list item <li> elements. Default:'• '
  • linksToUrls (bool): Convert links to (url) rather than removing? Default:true 3.0.132
  • linksToMarkdown (bool): Convert links to [text](url) rather than removing? Default:false 3.0.197
  • uppercaseHeadlines (bool): Convert headline tags to uppercase? Default:false 3.0.132
  • underlineHeadlines (bool): Underline headlines with "=" or "-"? Default:true 3.0.132
  • collapseSpaces (bool): Collapse extra/redundant extra spaces to single space? Default:true 3.0.132
  • replacements (array): Associative array of strings to manually replace. Default:[' ' => ' ']

Return value

string

See Also

WireTextTools methods and properties

API reference based on ProcessWire core version 3.0.251