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

Latest news

  • ProcessWire Weekly #554
    In the 554th issue of ProcessWire Weekly we'll check out the latest core updates, introduce a couple of new third party modules, and more. Read on!
    Weekly.pw / 21 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

“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