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

Twitter updates

  • New blog: Debugging tools built-in to ProcessWire. ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them… More
    1 July 2022
  • A review of weekly core updates, plus a simple recipe for a very effective listing cache—More
    24 June 2022
  • Weekly update: Making ProcessWire render pages at old WordPress URLs (or building a simple/custom URL router in PW): More
    17 June 2022

Latest news

  • ProcessWire Weekly #424
    In the 424th issue of ProcessWire Weekly we'll check out the latest weekly update from Ryan, introduce a new third party module, and more. Read on!
    Weekly.pw / 25 June 2022
  • Debugging tools built into ProcessWire
    ProcessWire's core comes with a lot of helpful debugging tools and capabilities built-in. In this post we'll cover some of these useful tools and how to use them.
    Blog / 1 July 2022
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK