Core Function WordWrap

WordWrap( <str>, <width>, <break>, <cut> )

Description

Wraps a string to a given number of characters.

Parameters

str

The input string.

width

The number of characters at which the string will be wrapped.

If 0 then it will wrap at every individual word.

If lower than 0 then it will be set to 0.

break

Optional; The line is broken using this string.

Default: "\n"

cut

If the cut is set to TRUE, the string is always wrapped at or before the specified width. So if you have a word that is larger than the given width, it is broken apart. (See second example).

Default: false

Return Value

Success: Returns the given string wrapped at the specified length.

Failure: Returns empty string.

Remarks

None.

Example

$text = "The quick brown fox jumped over the lazy dog.";
$newtext = wordwrap($text, 20, "<br />\n");
echo $newtext;
// PRINTS
// The quick brown fox<br />
// jumped over the lazy<br />
// dog.

Breaking words apart

$text = "A very long woooooooooooord.";
$newtext = wordwrap($text, 8, "\n", true);
echo "$newtext\n";
// PRINTS
// A very
// long
// wooooooo
// ooooord.

If the break is a single char and you are not breaking any words apart then it will simply place the break in the spaces it can find like so.

$text = "The quick brown fox jumped over the lazy dog.";
say wordwrap($text, 5, ",");
// PRINTS
// The,quick,brown,fox,jumped,over,the,lazy,dog.