nl2br( string $string[, bool $is_xhtml] )は、文字列「$string」の中の改行文字「\r\n、\n\r、\n、\r」の前に、HTMLの改行タグ<br>、もしくは、XHTML準拠の改行タグ<br />を挿入する組み込み関数。
定義
文字列型 nl2br( 文字列型 $string[, 論理型 $is_xhtml] );
パラメータ
- 文字列型 $string
改行文字の前に改行タグを挿入したい文字列を指定する。
- 論理型 $is_xhtml
オプション。
「PHP 5.3.0」で追加されたパラメータ。
HTMLの改行タグ
<br>を挿入するか、XHTML準拠の改行タグ<br />を挿入するか。「true」を指定すると、XHTML準拠の改行タグ
<br />を挿入する。「false」を指定すると、HTMLの改行タグ
<br>を挿入する。初期設定値は、「true」。
戻り値
「$string」の中の改行文字の前に、改行タグを挿入した文字列。
構文
改行文字の前に、XHTML準拠の改行タグを挿入（１）
改行タグを挿入した文字列 = nl2br( 対象文字列 );
「対象文字列」の中の改行文字「\r\n、\n\r、\n、\r」の前に、XHTML準拠の改行タグ<br />を挿入し、「改行タグを挿入した文字列」を返す。
改行文字の前に、XHTML準拠の改行タグを挿入（２）
改行タグを挿入した文字列 = nl2br( 対象文字列, true );
「対象文字列」の中の改行文字「\r\n、\n\r、\n、\r」の前に、XHTML準拠の改行タグ<br />を挿入し、「改行タグを挿入した文字列」を返す。
改行文字の前に、HTMLの改行タグを挿入
改行タグを挿入した文字列 = nl2br( 対象文字列, false );
「対象文字列」の中の改行文字「\r\n、\n\r、\n、\r」の前に、HTMLの改行タグ<br>を挿入し、「改行タグを挿入した文字列」を返す。
サンプル
改行文字の前に、XHTML準拠の改行タグを挿入（１）
<?php
$varStr = "Welcome \r\n My Homepage \n\r ようこそ \n 私のホームページへ \r (^^)";
echo nl2br( $varStr );
?>
$varStr = "Welcome \r\n My Homepage \n\r ようこそ \n 私のホームページへ \r (^^)";
echo nl2br( $varStr );
?>
↓↓↓出力結果↓↓↓
Welcome <br />
My Homepage <br />
ようこそ <br />
私のホームページへ <br />
(^^)
My Homepage <br />
ようこそ <br />
私のホームページへ <br />
(^^)
改行文字の前に、XHTML準拠の改行タグを挿入（２）
<?php
$varStr = "Welcome \r\n My Homepage \n\r ようこそ \n 私のホームページへ \r (^^)";
echo nl2br( $varStr, true );
?>
$varStr = "Welcome \r\n My Homepage \n\r ようこそ \n 私のホームページへ \r (^^)";
echo nl2br( $varStr, true );
?>
↓↓↓出力結果↓↓↓
Welcome <br />
My Homepage <br />
ようこそ <br />
私のホームページへ <br />
(^^)
My Homepage <br />
ようこそ <br />
私のホームページへ <br />
(^^)
改行文字の前に、HTMLの改行タグを挿入
<?php
$varStr = "Welcome \r\n My Homepage \n\r ようこそ \n 私のホームページへ \r (^^)";
echo nl2br( $varStr, false );
?>
$varStr = "Welcome \r\n My Homepage \n\r ようこそ \n 私のホームページへ \r (^^)";
echo nl2br( $varStr, false );
?>
↓↓↓出力結果↓↓↓
Welcome <br>
My Homepage <br>
ようこそ <br />
私のホームページへ <br>
(^^)
My Homepage <br>
ようこそ <br />
私のホームページへ <br>
(^^)