wordwrap()

wordwrap() — Wraps a string to a given number of characters.

Built-in function of PHP 8.5. The manual lists it as available in PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

What it does

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.

Signature

wordwrap(string $string, int $width = 75, string $break = "\n", bool $cut_long_words = false): string

Parameters

Parameter	Type	What it takes
$string	string	The input string.
$width	int	The number of characters at which the string will be wrapped.
$break	string	The line is broken using the optional break parameter. It must not be an empty string.
$cut_long_words	bool	If the cut_long_words 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 value

Returns the given string wrapped at the specified length.

Example

A runnable snippet:

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

Output:

The quick brown fox<br /> jumped over the lazy<br /> dog.

Changelog

Version	Change
8.0.0	If break is empty string, a ValueError is thrown; previously in this case it emitted an E_WARNING and returned false.