$sanitizer->line() method

Sanitize any string of text to single line, no HTML, and no specific max-length (unless given)

This is the same as the text() sanitizer but does not impose a maximum character length (or byte length) unless given one in the $maxLength argument. This is useful in cases where the text sanitizer’s built in 255 character max length (1020 max bytes) is not enough, or when you want to specify a max length as part of the method arguments.

Please note that like with the text sanitizer, the max length refers to a maximum number of characters, not bytes. The maxBytes is automatically set to the maxLength * 4, or can be specifically set via the maxBytes option.

Available since version 3.0.157.

Usage

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

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

Arguments

NameType(s)Description
valuestring

String to sanitize

maxLength (optional)int, array

Maximum length in characters, omit (0) for no max-length, or substitute $options array

options (optional)array

Options to modify behavior, see text() sanitizer for all options.

Return value

string

See Also


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #549
    In the 549th issue of ProcessWire Weekly we’re going to check out the latest core updates, highlight one older yet still very relevant third party module, and more. Read on!
    Weekly.pw / 17 November 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

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer