Menu Home

wordwrap

osbo.com | PHP | Functions | wordwrap

Wraps a string to a given number of characters

Syntax

wordwrap ( string $str [, int $width = 75 [, string $break = "\n" [, bool $cut = FALSE ]]] ) : string

Parameters

str

The input string.

width

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

break

The line is broken using the optional break parameter.

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. When FALSE the function does not split the word even if the width is smaller than the word width.

Return

Returns the given string wrapped at the specified length.

Examples

str

<?

$str = "The brown-and-white dog jumped over the other brown-and-white dog.";

$return = wordwrap($str);

echo $return;

?>
The brown-and-white dog jumped over the other brown-and-white dog.

width

<?

$str = "The brown-and-white dog jumped over the other brown-and-white dog.";
$width = 10;

$return = wordwrap($str, $width);

echo $return;

?>
The
brown-and-white
dog jumped
over the
other
brown-and-white
dog.

break

<?

$str = "The brown-and-white dog jumped over the other brown-and-white dog.";
$width = 10;
$break = "<br>";

$return = wordwrap($str, $width, $break);

echo $return;

?>
The<br>brown-and-white<br>dog jumped<br>over the<br>other<br>brown-and-white<br>dog.

cut

<?

$str = "The brown-and-white dog jumped over the other brown-and-white dog.";
$width = 10;
$break = "<br>";
$cut = true;

$return = wordwrap($str, $width, $break, $cut);

echo $return;

?>
The<br>brown-and-<br>white dog<br>jumped<br>over the<br>other<br>brown-and-<br>white dog.

PHP