wordwrap

wordwrap

wordwrap wraps a string to a column width, default is 80. As an optional second parameter, you can specify a string of text to wrap the text to the next line (default is carriage return \n). By default, {wordwrap} will attempt to wrap at a word boundary. If you want to cut off at the exact character length, pass the optional third parameter of true. This is equivalent to the PHP wordwrap() function.

Parameter PositionTypeRequiredDefaultDescription
1integerNo80This determines how many columns to wrap to.
2stringNo\nThis is the string used to wrap words with.
3booleanNofalseThis determines whether or not to wrap at a word boundary (false), or at the exact character (true).

Example 5-22. wordwrap

<?php
    
$smarty
->assign('articleTitle',
                
"Blind woman gets new kidney from dad she hasn't seen in years."
               
);

?>

where template is

{$articleTitle}

{$articleTitle|wordwrap:30}
    
{$articleTitle|wordwrap:20}
    
{$articleTitle|wordwrap:30:"<br />\n"}
    
{$articleTitle|wordwrap:30:"\n":true}

This will output:

Blind woman gets new kidney from dad she hasn't seen in years.

Blind woman gets new kidney
from dad she hasn't seen in
years.

Blind woman gets new
kidney from dad she
hasn't seen in
years.

Blind woman gets new kidney<br />
from dad she hasn't seen in<br />
years.

Blind woman gets new kidney
from dad she hasn't seen in
years.

See also nl2br and {textformat}.

© Copyright 2003-2023 www.php-editors.com. The ultimate PHP Editor and PHP IDE site.