$sanitizer->lines() method

Sanitize input string as multi-line text, no HTML tags, and no specific max length (unless given)

This is the same as the textarea() 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 textarea sanitizer’s built in 16kb character max length (64kb 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 textarea 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->lines(string $value);

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

Arguments

NameType(s)Description
valuestring

String value 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 textarea() sanitizer for all options.

Return value

string

See Also


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • Weekly update: Smooth rollout for ProcessWire 3.0.200 main/master, plus getting started on a new WP-to-PW site conversion and why they can be so rewarding— More
    20 May 2022
  • New main/master version of ProcessWire that has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release— More
    13 May 2022
  • Summary of weekly core updates for 22 April 2022 More
    22 April 2022

Latest news

  • ProcessWire Weekly #419
    In issue 419 of ProcessWire Weekly we'll check out this week's core updates, introduce a brand new recipe of the week, and more. Read on!
    Weekly.pw / 21 May 2022
  • ProcessWire 3.0.200 new master/main version
    This new main/master version has more than 220 commits, resolves more than 80 issues, adds numerous new features, performance improvements and optimizations, and consumes HALF the disk space of our previous release. This post covers all the details.
    Blog / 13 May 2022
  • 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