$sanitizer->trunc() method

Truncate string to given maximum length without breaking words and with no added visible extras

This is a shortcut to the truncate() sanitizer, sanitizing to nearest word with the more option disabled and the collapseLinesWith set to 1 space (rather than ellipsis).

Available since version 3.0.157.


// basic usage
$string = $sanitizer->trunc(string $str);

// usage with all arguments
$string = $sanitizer->trunc(string $str, $maxLength = 300, array $options = []);



String to truncate

maxLength (optional)int, array

Maximum allowed length in characters, or substitute $options argument here

options (optional)array

See options for truncate() method or specify type option (word, punctuation, sentence, block).

Return value


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #532
    In the 532nd issue of ProcessWire Weekly we'll cover the latest core updates, check out a couple of brand-new third party modules, and more. Read on!
    Weekly.pw / 20 July 2024
  • Page List Custom Children module
    This simple module gives you the ability to customize the parent/child relationship as it appears in the admin page list, enabling child pages to appear under more than one parent.
    Blog / 28 June 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer