limitChars() function - Documentation for SproutCMS

function limitChars()

Limits a plain-text phrase to a given number of characters.

File: /sprout/Helpers/Text.php, line 61
Namespace: Sprout\Helpers
Class: Text, Static method

Usage

string Text::limitChars ( string $str [, int $limit [, string $end_char [, boolean $preserve_words ]]] );

Arguments

string $str

Phrase to limit characters of, in plain text

int $limit = 100
```
Number of characters to limit to
```

string $end_char = NULL

Characters to append if text is limited, e.g. '...'

boolean $preserve_words = FALSE

True if whole words should be preserved; false to allow ending on a partial word

Return value

string
```
Plain text
```