e544ed6d9a
Comparing changes: https://github.com/smarty-php/smarty/compare/v4.3.1...v4.4.1 It is noticeable that Smarty 4.3.1 does not officially support PHP 8.3. Is only supported with 4.4.0. Remark: During tests with Smarty 4.5.1, it was noticed that the following warning occurs: Deprecated: Using the unregistered function "function_exists" in a template is deprecated and will be removed in a future version. Use Smarty::registerPlugin to explicitly register a custom modifier. As of Smarty 5.X.X, templates must be revised again. The Smarty release 5.0.2 is already officially available. However, integration into FlatPress is not entirely trivial.
58 lines
2.7 KiB
Markdown
58 lines
2.7 KiB
Markdown
# truncate
|
|
|
|
This truncates a variable to a character length, the 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.
|
|
|
|
## Basic usage
|
|
```smarty
|
|
{$myVar|truncate:40:"..."}
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter Position | Type | Required | Default | Description |
|
|
|--------------------|---------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| 1 | integer | No | 80 | This determines how many characters to truncate to. |
|
|
| 2 | string | No | \... | This is a text string that replaces the truncated text. Its length is included in the truncation length setting. |
|
|
| 3 | boolean | No | FALSE | This determines whether or not to truncate at a word boundary with FALSE, or at the exact character with TRUE. |
|
|
| 4 | boolean | No | FALSE | This determines whether the truncation happens at the end of the string with FALSE, or in the middle of the string with TRUE. Note that if this setting is TRUE, then word boundaries are ignored. |
|
|
|
|
## Examples
|
|
|
|
```php
|
|
<?php
|
|
$smarty->assign('articleTitle', 'Two Sisters Reunite after Eighteen Years at Checkout Counter.');
|
|
```
|
|
|
|
where template is:
|
|
|
|
```smarty
|
|
{$articleTitle}
|
|
{$articleTitle|truncate}
|
|
{$articleTitle|truncate:30}
|
|
{$articleTitle|truncate:30:""}
|
|
{$articleTitle|truncate:30:"---"}
|
|
{$articleTitle|truncate:30:"":true}
|
|
{$articleTitle|truncate:30:"...":true}
|
|
{$articleTitle|truncate:30:'..':true: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...
|
|
Two Sisters Re..ckout Counter.
|
|
```
|
|
|