wrap

Wraps text so that each line has a specified maximum number
of characters.

wrap(String, limit [, strip]) → returns string

  1. CFDocs
  2. Functions
  3. String Functions
  4. wrap
  5. CF
  6. Lucee
  7. 0 Issue
  8. Edit

Argument Reference

String string
Required

String or variable that contains one. The text to wrap.

limit numeric
Required

Positive integer maximum number of characters to allow on
a line.

strip boolean
Default: false

Whether to remove all existing newline and carriage return
characters in the input string with spaces before wrapping
the text. Default: False.
Values:
  • true
  • false

Examples
Sample code invoking the wrap function 

sentence = "This is a standard sentence.";
wrappedSentence = wrap(sentence, 7);
writeOutput(wrappedSentence);

Expected Result: This is a standar d senten ce.

<cfset sentence = "This is a standard sentence." />
<cfset wrappedSentence = wrap(sentence, 7) />
<cfoutput>#wrappedSentence#</cfoutput>

Expected Result: This is a standar d senten ce.

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub