nl2br

(PHP 4, PHP 5, PHP 7)

Inserts HTML line breaks before all newlines in a string

string nl2br ( string $string [, bool $is_xhtml = true ] )

Returns string with '<br />' or '<br>' inserted before all newlines (\r\n, \n\r, \n and \r).

Parameters:

string

The input string.

is_xhtml

Whether to use XHTML compatible line breaks or not.

Returns:

Returns the altered string.

Changelog:

5.3.0

Added the optional is_xhtml parameter. Before this version '<br />' was always inserted.

Examples:

Using nl2br()

<?php
echo nl2br("foo isn't\n bar");
?>

The above example will output:

foo isn't<br />
 bar

Generating valid HTML markup using the is_xhtml parameter

<?php
echo nl2br("Welcome\r\nThis is my HTML document", false);
?>

The above example will output:

Welcome<br>
This is my HTML document

Various newline separators

<?php
$string = "This\r\nis\n\ra\nstring\r";
echo nl2br($string);
?>

The above example will output:

This<br />
is<br />
a<br />
string<br />