truncate

truncate

This truncates a variable to a character length, default is 80. As an optional second parameter, you can specify a string of text to display at the end if the variable was truncated. The characters in the string are included with the original truncation length. By default, truncate will attempt to cut off at a word boundary. If you want to cut off at the exact character length, pass the optional third parameter of true.

Parameter PositionTypeRequiredDefaultDescription
1integerNo80This determines how many characters to truncate to.
2stringNo...This is a text string that replaces the truncated text. Its length is NOT included in the truncation length setting.
3booleanNofalseThis determines whether or not to truncate at a word boundary (false), or at the exact character (true).
4booleanNofalseThis determines whether the truncation happens at the end of the string (false), or in the middle of the string (true). Note that if this setting is true, then word boundaries are ignored.

Example 5-20. truncate

<?php
    
$smarty
->assign('articleTitle''Two Sisters Reunite after Eighteen Years at Checkout Counter.');

?>

where template is:

{$articleTitle}
{$articleTitle|truncate}
{$articleTitle|truncate:30}
{$articleTitle|truncate:30:""}
{$articleTitle|truncate:30:"---"}
{$articleTitle|truncate:30:"":true}
{$articleTitle|truncate:30:"...":true}

This will output:

Two Sisters Reunite after Eighteen Years at Checkout Counter.
Two Sisters Reunite after Eighteen Years at Checkout Counter.
Two Sisters Reunite after...
Two Sisters Reunite after
Two Sisters Reunite after---
Two Sisters Reunite after Eigh
Two Sisters Reunite after E...
© Copyright 2003-2014 www.php-editors.com. The ultimate PHP Editor and PHP IDE site.