PHP: wordwrap() function

Last update on October 04 2024 11:10:12 (UTC/GMT +8 hours)

PHP: Wraps a string to a given number of characters

The wordwrap() function is used to wraps a string to a given number of characters. Wraps a string to a given number of characters using a string break character.

Version:

(PHP 4 and above)

Syntax:

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

Parameter:

Name	Description	Required / Optional	Type
str	The input string.	Required	String
width	The number of characters at which the string will be wrapped.	Required	String
break	The line is broken using the optional break parameter.	Required	String
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.	Required	String

Return values:

Returns the given string wrapped at the specified length.

Value Type: String.

Pictorial Presentation:

Example:

<?php
  $text = "The quick brooooooooooooooooooown fox jumps over the lazy dog.";
  $newtext = wordwrap($text, 8, "\n", false);
echo "$newtext\n";
?>

Output:

The
quick
brooooooooooooooooooown
fox
jumps
over the
lazy
dog.

View the example in the browser

See also

PHP Function Reference

Previous: vprintf
Next: Installing and configuring PHP Variable Handling