PHPの文字列の改行コードとHTMLへ出力時のnl2br関数での置換

PHPなどプログラム上での改行はちょっと注意が必要です。

プログラムは基本的に改行やスペースを認識しません。

1行のプログラムの終了はPHPの場合だと ; までとなります。

でも文字列をログや画面に出力する際に、改行させてきれいに表示したいと思いますよね?

文字列内の改行は改行として認識してくれますが、その改行を入れる方法を以下に説明します。

PHPの文字列内の改行

PHPの文字列を改行させるためには、改行コードを挟む必要があります。

その改行コードを挟む方法は以下の3つがあります。

エスケープ文字(\n)を使って改行

文字列内で使うエスケープ文字については以前にも触れました。

≫ PHPの文字列の検索や分割、置換などの基本操作とエスケープ文字

 

エスケープ文字の \n を使うと文字列に改行を挿入することが出来ます。

例えば次のように文字列を定義しログに出力したとします。

ログの内容は、

のようになります。

 

ちなみにUNIX系のOSは \n ですが、Windowsの場合は \r\n のように書きます。

Windows環境でXAMPPなどでテストする場合は \r\n のように書かないと改行されません。

UNIX環境で \r\n と書いても正常に改行されます。

文字列定義時に普通に(?)改行

まあ、エスケープ文字の改行を上で紹介しましたけど、普通に文字列で改行しても同じように改行できます。

このように書いても、

のようになります。

 

この方法だったら環境依存は無かったと思います。

「・・・と思います。」というのは、あまり使わない方法だからです。

プログラムコード的に問題は無いのですが、コードの見た目がかなりださくなります。

 

上記のサンプルコードだと分かりづらいですが、インデントされると猛烈にださくなります。

改行した次の行は、インデント無しで行の先頭から書かないといけません。

改行した次の行をインデントすると、インデントした分の余計な余白が文字列として認識されてしまいます。

見た目がださくなりますし、何より読みづらくなってしまうため僕は使いません。

PHP_EOLを使って改行

PHP_EOLは実行環境のOSに対応する改行コードを出力する定数になります。 例えば、Windows環境の改行コードは 「\r\n(CRLF)」 Linux/Unix系、MacOS等の改行コードは「\n(LF)」になります。

引用:TechAcademyマガジン

PHP_EOLは環境に依存しない改行コードです。

便利ですね。

これを使って、

のように書けば、

のようになります。

 

ただ、文字列の中に一緒に書くことは出来ず、改行ごとに文字列を連結し、間に PHP_EOL を挟んで改行する必要があります。

これは面倒ですし、見た目的にもちょっと見づらくなります。

通常はシステムを搭載する環境はプログラミングの前に分かることなので、ちゃんと環境に合わせた”\n”などを使えば問題ないかと思います。

HTMLへnl2br関数で出力

上で紹介した内容は文字列に改行を挿入するというものでした。

ログだけでなくメールの文章を作成したりする場合などにも使えます。

しかし、画面に出力するときには上記の方法だけでは改行は挟めません。

 

例えば以下のようはHTMLがあったとします。

これを表示するとどうなると思いますか?

答えは、改行されないです。

HTMLもスペースや改行は認識されないので、表示時に改行されずに表示されてしまうのです。

のように書いた結果と同じになります。

 

HTMLで改行するためには<br>というタグが必要です。

そして、PHPで作成した改行を含む文字列の改行コードを<br>に置換してくれる便利な関数がPHPにはあります。

それが、nl2br() です。

 

nl2br()の引数に改行コードを含めた文字列をセットするだけで、HTMLの改行タグに変換された文字列を返してくれます。

のように書いて画面に出力すると、

のように出力してくれて、ブラウザで表示したときにも改行して表示されます。

まとめ

PHPもHTMLも、通常は改行を認識されない。

PHPの文字列内に書いた改行は改行と認識してくれるが、見た目がださいのであまり使わない。

文字列内に改行のエスケープ文字 \n を挿入すると改行できる。Windowsの場合は \r\n となる。

環境に依存しない改行コードとして PHP_EOL があるが、文字列内に挿入は出来ず、行ごとに連結する必要がある。

改行を挿入した文字列をそのままHTMLに出力しても改行されない。

HTMLに出力するためには \n などの改行コードをHTMLの改行タグ <br /> に変換しないといけない。

変換はPHPの nl2br() を使えば一発でできます。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA