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

Twitter updates

  • Quick weekly update covering this week's commits for the upcoming 3.0.167 ProcessWire core version— More
    18 September 2020
  • This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder— More
    11 September 2020
  • Weekly update – 28 August 2020 – New secure files option defined per-template: More
    28 August 2020

Latest news

  • ProcessWire Weekly #332
    In the 332nd issue of ProcessWire Weekly we'll cover the latest core updates, introduce some new and updated ProcessWire resources, and more. Read on!
    Weekly.pw / 19 September 2020
  • ProcessWire 3.0.166 core updates and more
    This week ProcessWire version 3.0.166 is released on the dev branch. In this post we’ll cover all that’s new relative to the previous version, 3.0.165. Plus we’ll check out the latest new versions of ProCache and FormBuilder.
    Blog / 11 September 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.