PHPのnl2br()関数とは？使い方と実行例をわかりやすく解説

nl2br()関数とは？

PHPのnl2br()関数は、文字列内にあるすべての改行コードの直前にHTMLの改行タグを挿入するための関数です。テキストエリアから送信されたデータやデータベースから取得した文字列には「\n」などの改行コードが含まれていますが、そのままブラウザに表示しても改行は反映されません。nl2br()関数を使えば、改行コードを自動的に<br>タグへ変換でき、Webページ上でも正しく改行して表示できるようになります。

この関数が改行として認識する主な改行コードは以下のとおりです。

• \n（LF：ラインフィード）
• \r（CR：キャリッジリターン）
• \r\n（CRLF）
• \n\r

構文

nl2br(str, xhtml)

パラメータ

• str − 変換対象となる文字列を指定します。

• xhtml − XHTML互換の改行タグを使用するかどうかを真偽値（bool）で指定します。

  • true − 「<br />」を挿入します。これがデフォルト値です。

  • false − 「<br>」を挿入します。

戻り値

nl2br()関数は、各改行コードの前に改行タグが挿入された変換後の文字列を返します。元の文字列自体は変更されない点に注意してください。

使用例1：第2引数にfalseを指定した場合

次の例では、第2引数のxhtmlにfalseを指定しているため、「<br>」タグが挿入されます。

<?php
    echo nl2br("This has multiple \nlines\nhere!", false);
?>

出力結果

This has multiple
lines
here!

出力されたHTMLソースを確認すると、元の改行コード（\n）の位置に<br>タグが挿入されていることがわかります。

使用例2：\r\n（CRLF）を含む文字列の場合

Windows環境で一般的な「\r\n」という改行コードにも問題なく対応できます。

<?php
    echo nl2br("This is\r\ndemo text!", false);
?>

出力結果

This is
demo text!

まとめ

nl2br()関数は、文字列中の改行コード（\n、\r、\r\nなど）の前にHTMLの改行タグを挿入する、シンプルながら非常に便利な関数です。第2引数の指定によって「<br />」（XHTML形式・デフォルト）と「<br>」（HTML5形式）を使い分けられる点も覚えておきましょう。掲示板やコメント欄など、ユーザーが入力したテキストをWebページに表示する場面で特に活躍します。