wordwrap

Wraps a string to a given number of characters.

wordwrap Function synopsis

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

Parameters

$string

Typestring

The input string.

$width

OptionalTypeintDefault value75

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

$break

OptionalTypestringDefault value"\n"

The line is broken using the optional $break parameter. It must not be an empty string.

$cut_long_words

OptionalTypeboolDefault valuefalse

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

Typestring

Returns the given string wrapped at the specified length.