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


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

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



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


See Also

$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.228

Latest news

  • ProcessWire Weekly #493
    In the 493rd issue of ProcessWire Weekly we'll check out ProcessWire 3.0.230, introduce a couple of brand new modules, and more. Read on!
    Weekly.pw / 21 October 2023
  • Timing attacks and how to prevent them
    This week we'll take a look at a new (but simple) module available for ProcessWire that helps to prevent timing attacks. We'll cover what timing attacks are, how they work, and how to prevent them.
    Blog / 20 October 2023
  • 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