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

Twitter updates

  • This post covers a few of the bigger updates in ProcessWire 3.0.154+3.0.155. This includes new live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our input->urlSegment() method! More
    24 April 2020
  • A brief look at what's new in ProcessWire 3.0.154 in this forum post: More
    17 April 2020
  • This week we’ve got a few new and interesting core updates in progress, though none quite ready to release just yet. So rather than releasing version 3.0.154 today, I thought we'd instead take a brief look at what’s coming over the next few weeks… More
    3 April 2020

Latest news

  • ProcessWire Weekly #311
    In the 311th issue of ProcessWire Weekly we're going to talk a bit about the latest dev versions of ProcessWire, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 25 April 2020
  • ProcessWire 3.0.154 and 3.0.155 core updates
    This post covers a few of the bigger updates in ProcessWire 3.0.154 and 3.0.155 on the dev branch. This includes a new function for live replacement of text in core and modules, a new method for creating canonical URLs, and some major upgrades to our $input->urlSegment() method that I think you’ll like!
    Blog / 24 April 2020
  • 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.