nl2br

(PHP 4, PHP 5, PHP 7)

nl2br — 改行文字の前に HTML の改行タグを挿入する

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

string に含まれるすべての改行文字 (\r\n、 \n\r、\n および \r) の前に <br /> あるいは <br> を挿入して返します。

変更後の文字列を返します。

例1 nl2br() の使用法


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

上の例の出力は以下となります。

foo isn't<br />
 bar

例2 is_xhtml パラメータの使用による、妥当な HTML 形式のマークアップの生成


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

上の例の出力は以下となります。

Welcome<br>
This is my HTML document

例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 />' が挿入されていました。