String Functions
PHP Manual

nl2br

(PHP 4, PHP 5)

nl2brInserts HTML line breaks before all newlines in a string

Description

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

Returns string with '<br />' or '<br>' inserted before all newlines.

Parameters

string

The input string.

is_xhtml

Whenever to use XHTML compatible line breaks or not.

Return Values

Returns the altered string.

Examples

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 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

Changelog

Version Description
5.3.0 Added the optional is_xhtml parameter.
4.0.5 nl2br() is now XHTML compliant. All older versions will return string with '<br>' inserted before newlines instead of '<br />'.

See Also


String Functions
PHP Manual