truncate()

Signature

truncate() — returns string

Available in: controller, model, mapper, migrator, migration, tabledefinition Category: String Functions

Description

Truncates text to the specified length and replaces the last characters with the specified truncate string (which defaults to ”…”).

Parameters

Name	Type	Required	Default	Description
text	string	yes	—	The text to truncate.
length	numeric	no	30	Length to truncate the text to.
truncateString	string	no	...	String to replace the last characters with.

Examples

// 1. Truncate to a specific character length (defaults to "..." suffix)
truncated = truncate(text="CFWheels is a framework for ColdFusion", length=20);
// truncated -> "CFWheels is a fra..."

// 2. Use a custom truncate string instead of the default ellipsis
truncated = truncate(text="CFWheels is a framework for ColdFusion", truncateString=" (more)");
// truncated -> "CFWheels is a framework fo (more)"

// 3. Text shorter than the length limit is returned unchanged
truncated = truncate(text="Hello", length=30);
// truncated -> "Hello"