(PHP 4, PHP 5, PHP 7)
nl2br — Inserts HTML line breaks before all newlines in a string
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
).
string
The input string.
use_xhtml
Whether to use XHTML compatible line breaks or not.
Returns the altered string.
Example #1 Using nl2br()
<?php echo nl2br("foo isn't\n bar"); ?>
The above example will output:
foo isn't<br /> bar
Example #2 Generating valid HTML markup using the use_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
Example #3 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 />
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.nl2br.php