$sanitizer->markupToLine() method

Convert a string containing markup or entities to be a single line of plain text

This is the same as the [$sanitizer->markupToText()](/api/ref/sanitizer/markup-to-$sanitizer->markupToText()/) method except that the return value is always just a single line.

Usage

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

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

Arguments

NameType(s)Description
valuestring

Value to convert

options (optional)array

Options to modify default behavior:

  • newline (string): Character(s) to replace newlines with (default=" ").
  • separator (string): Character(s) to separate HTML
  • items with (default=", ").
  • 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 on a single line


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.248

Latest news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK