nl2br
PHP function
Edit on GitHub ✎
(PHP 4, PHP 5, PHP 7, PHP 8)
Inserts HTML line breaks before all newlines in a string
Description
nl2br(string $string, bool $use_xhtml = true): string
Returns string with <br /> or <br> inserted before all newlines (\r\n, \n\r, \n and \r).
Parameters
stringThe input string.
use_xhtmlWhether to use XHTML compatible line breaks or not.
Return Values
Returns the altered string.
Examples
Using nl2br()
php
<?php
echo nl2br("foo isn't\n bar");
?>The above example will output:
output
foo isn't<br />
barGenerating valid HTML markup using the use_xhtml parameter
php
<?php
echo nl2br("Welcome\r\nThis is my HTML document", false);
?>The above example will output:
output
Welcome<br>
This is my HTML documentVarious newline separators
php
<?php
$string = "This\r\nis\n\ra\nstring\r";
echo nl2br($string);
?>The above example will output:
output
This<br />
is<br />
a<br />
string<br />