# nl2br

(PHP 4, PHP 5, PHP 7)

nl2br — 在字符串所有新行之前插入 HTML 换行标记

### 说明

nl2br ( string `$string` [, bool `$is_xhtml` = `TRUE` ] ) : string

在字符串 `string` 所有新行之前插入 `'<br />'` 或 `'<br>'`，并返回。

### 参数

`string`

  输入字符串。

`is_xhtml`

  是否使用 XHTML 兼容换行符。

### 返回值

返回调整后的字符串。

### 范例

Example #1 nl2br() 使用范例

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

以上例程会输出：

    foo isn't<br />
     bar

Example #2 使用 `is_xhtml` 生成合法的 HTML 标记

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

以上例程会输出：

    Welcome<br>
    This is my HTML document

Example #3 各种换行分隔符

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

以上例程会输出：

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

### 更新日志

版本 | 说明
--- | ---
5.3.0 | 新增可选的 `is_xhtml` 参数。在此之前，总是插入 '<br />'。

### 参见

- htmlspecialchars() - 将特殊字符转换为 HTML 实体
- htmlentities() - 将字符转换为 HTML 转义字符
- wordwrap() - 打断字符串为指定数量的字串
- str_replace() - 子字符串替换