wordwrap
(PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8)
Wraps a string to a given number of characters
Description
Wraps a string to a given number of characters using a string break character. Strings wrap after a space (U+0020) character unless cut_long_words is set to true.
Parameters
stringThe input string.
widthThe number of characters at which the string will be wrapped.
breakThe line is broken using the optional
breakparameter. It must not be an empty string.cut_long_wordsIf the
cut_long_wordsis set to true, the string is always wrapped at or before the specifiedwidth. 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 thewidthis smaller than the word width.
Return Values
Returns the given string wrapped at the specified length.
Errors/Exceptions
If break is an empty string, a ValueError is thrown.
Changelog
| Version | Description |
|---|---|
| 8.0.0 | If break is empty string, a ValueError is thrown; previously in this case it emitted an E_WARNING and returned false. |
Examples
wordwrap() example
<?php
$text = "The quick brown fox jumped over the lazy dog.";
$newtext = wordwrap($text, 20, "<br />\n");
echo $newtext;
?>The above example will output:
The quick brown fox<br />
jumped over the lazy<br />
dog.wordwrap() example
<?php
$text = "A very long woooooooooooord.";
$newtext = wordwrap($text, 8, "\n", true);
echo "$newtext\n";
?>The above example will output:
A very
long
wooooooo
ooooord.wordwrap() example
<?php
$text = "A very long woooooooooooooooooord. and something";
$newtext = wordwrap($text, 8, "\n", false);
echo "$newtext\n";
?>The above example will output:
A very
long
woooooooooooooooooord.
and
something