【PHP8.x】nl2br関数の使い方

nl2br関数は、指定された文字列内の改行文字をHTMLの<br>タグに変換して返す関数です。この関数は、ユーザーがテキストエリアに入力した改行を含む文字列をウェブページ上で表示する際に特に役立ちます。HTMLは通常、連続する空白文字や改行文字を一つの空白として扱ってしまうため、入力された改行をそのままの形でブラウザに表示させるには、<br>タグへの変換が必要になります。

具体的な動作として、\n（ラインフィード）や\r\n（キャリッジリターンとラインフィード）といった改行コードが検出されると、それらをHTMLの<br>タグに置き換えます。これにより、テキストエリアで改行された部分が、ブラウザ上でも視覚的に改行されて表示されるようになります。

この関数は、変換したい文字列を唯一の必須引数として受け取ります。PHP 8.0.0以降、オプションの第二引数としてuse_xhtmlがありましたが、PHP 8.1.0以降ではこの引数は無視され、常にHTML5互換の<br>タグが生成されるようになりました。したがって、現在のPHP環境では、単に変換対象の文字列を引数として渡すだけで利用できます。

例えば、ユーザーが「こんにちは\n世界」と入力した場合、nl2br関数を適用すると「こんにちは<br>世界」という文字列が得られ、これがブラウザで表示されると「こんにちは」の後に改行が入り「世界」と表示されます。このように、プレーンテキストの改行をウェブページで正しく表現するための基本的なツールとして広く利用されています。

<?php
$original_string = "これは\n改行を含む\nテキストです。";
$converted_string = nl2br($original_string);
echo $converted_string;
?>

string $string, bool $use_xhtml = false

• string $string: 改行コード(\n)を<br>タグに置換する対象の文字列
• bool $use_xhtml = false: XHTML互換の<br />タグを使用するかどうかを示す真偽値 (trueでXHTML互換)

string

文字列中の改行文字（\n）をHTMLの改行タグ（<br />）に変換した新しい文字列を返します。