nl2br
(PHP 4, PHP 5)
nl2br — 改行文字の前に HTML の改行タグを挿入する
説明
string nl2br
( string $string
[, bool $is_xhtml = true
] )
string に含まれるすべての改行文字の前に '<br />' あるいは '<br>' を挿入して返します。
パラメータ
- string
-
入力文字列。
- is_xhtml
-
XHTML 準拠の改行を使うか否か。
返り値
変更後の文字列を返します。
例
例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
変更履歴
| バージョン | 説明 |
|---|---|
| 5.3.0 | オプションの is_xhtml パラメータが追加されました。 |
| 4.0.5 | nl2br() は XHTML 準拠となりました。 PHP 4.0.5 より前の全てのバージョンでは、 nl2br() は、string の全ての改行記号の前に '<br />' の代わりに '<br>' を挿入して返します。 |
参考
- htmlspecialchars() - 特殊文字を HTML エンティティに変換する
- htmlentities() - 適用可能な文字を全て HTML エンティティに変換する
- wordwrap() - 文字列分割文字を使用して、指定した文字数に文字列を分割する
- str_replace() - 検索文字列に一致したすべての文字列を置換する
