$sanitizer->markupToText() method

Convert a string containing markup or entities to be plain text

This is one implementation but there is also a better one that you may prefer with the WireTextTools::markupToText() method. Try both to determine which suits your needs best:

Example

$markup = '<html>a bunch of HTML here</html>';
// try both to see what you prefer:
$text1 = $sanitizer->markupToText($html);
$text2 = $sanitizer->getTextTools()->markupToText(); 

Usage

// basic usage
$string = $sanitizer->markupToText(string $value);

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

Arguments

NameType(s)Description
valuestring

String you want to convert

options (optional)array

Options to modify default behavior:

  • newline (string): Character(s) to replace newlines with (default="\n").
  • separator (string): Character(s) to separate HTML <li> items with (default="\n").
  • entities (bool): Entity encode returned value? (default=false).
  • trim (string): Character(s) to trim from beginning and end of value (default=" -,:;|\n\t").

Return value

string

Converted string of text

See Also


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #555
    In the 555th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module that adds the ability to automatically convert email messages to pages, and more. Read on!
    Weekly.pw / 28 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

“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