nl2br

Inserts HTML line breaks before all newlines in a string

&reftitle.description; `string` `nl2br` `string` `string` `bool` `use_xhtml`&true;

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

&reftitle.parameters;

`string`

- The input string.

`use_xhtml`

- Whether to use XHTML compatible line breaks or not.

&reftitle.returnvalues;

Returns the altered string.

&reftitle.examples;

### Using `nl2br`

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

&example.outputs;

    foo isn't<br />
     bar

### Generating valid HTML markup using the `use_xhtml` parameter

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

&example.outputs;

    Welcome<br>
    This is my HTML document

### Various newline separators

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

&example.outputs;

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

&reftitle.seealso;

- `htmlspecialchars`
- `htmlentities`
- `wordwrap`
- `str_replace`