WORDWRAP(3) 1 WORDWRAP(3)
wordwrap - Wraps a string to a given number of characters
SYNOPSIS
string wordwrap (string $str, [int $width = 75], [string $break = "0], [bool $cut = false])
DESCRIPTION
Wraps a string to a given number of characters using a string break character.
PARAMETERS
o $str
- The input string.
o $width
- The number of characters at which the string will be wrapped.
o $break
- The line is broken using the optional $break parameter.
o $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). When FALSE the function does not split the word even if the $width
is smaller than the word width.
RETURN VALUES
Returns the given string wrapped at the specified length.
EXAMPLES
Example #1
wordwrap(3) example
<?php
$text = "The quick brown fox jumped over the lazy dog.";
$newtext = wordwrap($text, 20, "<br />
");
echo $newtext;
?>
The above example will output:
The quick brown fox<br />
jumped over the lazy<br />
dog.
Example #2
wordwrap(3) example
<?php
$text = "A very long woooooooooooord.";
$newtext = wordwrap($text, 8, "
", true);
echo "$newtext
";
?>
The above example will output:
A very
long
wooooooo
ooooord.
Example #3
wordwrap(3) example
<?php
$text = "A very long woooooooooooooooooord. and something";
$newtext = wordwrap($text, 8, "
", false);
echo "$newtext
";
?>
The above example will output:
A very
long
woooooooooooooooooord.
and
something
SEE ALSO
nl2br(3), chunk_split(3).
PHP Documentation Group WORDWRAP(3)