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

Usage

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

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

Arguments

NameType(s)Description
strstring

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

string


$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.168

Twitter updates

  • Preliminary 2021 roadmap in progress in this week’s update— More
    8 January 2021
  • Happy New Year! Today I’ve bumped the version on the dev branch to 3.0.170, and it’s quite a lot of updates. This post covers most of them. In this post, there’s also a question for you: what would you like to see in ProcessWire in 2021? More
    1 January 2021
  • In this week’s blog post we’ll take a brief look at a powerful new ProFields module for ProcessWire that’s just around the corner—the Combo field: More
    4 December 2020

Latest news

  • ProcessWire Weekly #348
    In the 348th issue of ProcessWire Weekly we're going to check out the first version of the new roadmap for ProcessWire, talk a bit about front-end frameworks, and introduce a new site of the week. Read on!
    Weekly.pw / 9 January 2021
  • ProcessWire 3.0.170 core updates
    Happy New Year! Today I’ve bumped the version on the dev branch to 3.0.170, and it’s quite a lot of updates. This post covers most of them. In this post, there’s also a question for you: what would you like to see in ProcessWire in 2021?
    Blog / 1 January 2021
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull