$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.172

Twitter updates

  • ProcessWire 3.0.174 core updates: improvements to the new path/URL hooks and more— More
    12 March 2021
  • ProcessWire 3.0.173 adds several new requested features and this post focuses on one of my favorites: the ability to hook into and handle ProcessWire URLs, independent of pages— More
    5 March 2021
  • This week ProcessWire gained powerful new tools for finding pages and controlling how they are loaded. If you like to maximize performance and efficiency, you’ll like what 3.0.172 brings— More
    5 February 2021

Latest news

  • ProcessWire Weekly #358
    In the 358th issue of ProcessWire Weekly we'll walk you through the latest core updates, check out a new site profile, introduce the Admin Restrict Branch Select module, and more. Read on!
    Weekly.pw / 20 March 2021
  • ProcessWire 3.0.173 core updates: New URL hooks
    ProcessWire 3.0.173 adds several new requested features and this post focuses on one of my favorites: the ability to hook into and handle ProcessWire URLs, independent of pages.
    Blog / 5 March 2021
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer