PHPの改行：\n、PHP_EOL、nl2brの使い方

改行を出力するには、ダブルクォートの文字列の中に\nを書きます：echo "Line 1\nLine 2";。定数PHP_EOLも同じことをし、行末に書くとより読みやすくなります：echo 'Done' . PHP_EOL;。Webページでは改行は改行として表示されないので、<br>かnl2br()が必要です。

<?php
echo "Line 1\nLine 2\n";
echo 'Done' . PHP_EOL;

echo "Name:\tAda\n";      // \t is a tab
echo "Language:\tPHP\n";

シングルクォートとダブルクォートの違い

\nや\tのようなエスケープシーケンスは、ダブルクォートの中でしか働きません。シングルクォートの中の'\n'は、バックスラッシュと文字nの2文字です。これが「\nが効かない」のよくある原因です。

<?php
echo 'Single: one\ntwo', "\n";
echo "Double: one\ntwo", "\n";

echo strlen('\n'), "\n";  // 2 characters
echo strlen("\n"), "\n";  // 1 character

// Joining single-quoted text with a newline
echo 'one' . "\n" . 'two' . PHP_EOL;

ダブルクォートが理解するすべてのエスケープシーケンスは、文字列のページに載っています。

PHP_EOLと"\n"の違い

PHP_EOLは、PHPが動いているシステムの改行コードで、LinuxとmacOSでは"\n"、Windowsでは"\r\n"です。ターミナルへの出力や、同じマシンで読むファイルに使います。形式が独自の改行コードを定めているときはそれを使います。HTTPヘッダーとメールには"\r\n"が必要で、ほとんどのツールはどこでも"\n"を問題なく読めます。

<?php
var_dump(PHP_EOL);
var_dump(PHP_EOL === "\n");

$lines = ['apples', 'pears', 'plums'];
file_put_contents('list.txt', implode(PHP_EOL, $lines) . PHP_EOL);

echo file_get_contents('list.txt');
echo "Lines in file: ", count(file('list.txt')), "\n";

"\r"は復帰（キャリッジリターン）、"\n"は改行（ラインフィード）です。Windowsのファイルは行末に両方、つまり"\r\n"を使うので、Windowsのユーザーや<textarea>から来たテキストには、予想していない\rの文字がよく含まれています。

HTMLでの改行：brとnl2br

ブラウザは改行を1つの空白にまとめるので、echo "a\nb"はページにa bと表示されます。自分で<br>を出力するか、テキストの改行を残したまま、それぞれの前に<br />を挿入するnl2br()で変換します。実行して、OutputタブとPageタブを比べてください。

<?php
$address = "221B Baker Street\nLondon\nNW1 6XE";

echo "<p><strong>Raw newlines:</strong> ", $address, "</p>\n";
echo "<p><strong>With nl2br:</strong><br>", nl2br($address), "</p>\n";
echo "<p><strong>With pre:</strong></p><pre>", $address, "</pre>\n";

Outputタブでは3つとも似たように見えます。Pageタブでは、1つ目は1行につながり、nl2br()は改行され、<pre>は書いたとおりに改行を保ちます。

textareaの入力を改行付きで表示する

<textarea>から来たテキストはユーザーが入力した行を保っていますが、HTMLに出力する前にエスケープする必要があります。順番が重要で、先にhtmlspecialchars()、次にnl2br()です。逆にすると<br />タグそのものがエスケープされてしまいます。実行し、ボックスに何行か入力してPreviewを押すと、$_POSTに値が入った状態で同じスクリプトがもう一度実行されます。

<?php
$note = $_POST['note'] ?? '';
?>
<form method="post">
    <textarea name="note" rows="4" cols="30"><?= htmlspecialchars($note) ?></textarea><br>
    <button>Preview</button>
</form>
<?php if ($note !== ''): ?>
    <h3>Preview</h3>
    <p><?= nl2br(htmlspecialchars($note)) ?></p>
    <p><?= substr_count($note, "\n") + 1 ?> lines</p>
<?php endif; ?>

textareaの改行は"\r\n"か"\n"で届きますが、どちらも"\n"を含むので、その文字を数えればどちらでも正しく動きます。ここでエスケープが省略できない理由はhtmlspecialchars()で説明しています。

改行で文字列を分割する

explode("\n", $text)は自分で作ったテキストなら動きます。ユーザーやファイルから来たテキストでは、改行コードが"\r\n"、"\n"、"\r"のいずれかかもしれません。\Rはあらゆる改行に一致するので、preg_split('/\R/', $text)ならそのすべてを扱えます。

<?php
$text = "first\r\nsecond\nthird\rfourth";

$lines = preg_split('/\R/', $text);
print_r($lines);

// explode leaves \r at the end of "first"
$naive = explode("\n", $text);
var_dump($naive[0]);

// Skip empty lines too
$text2 = "a\n\nb\n\n\nc\n";
print_r(preg_split('/\R/', $text2, -1, PREG_SPLIT_NO_EMPTY));

文字列から改行を取り除く

複数行のテキストを1行にするには、すべての種類の改行コードを置換します。1文字の改行より先に"\r\n"を置換してください。そうしないと、Windowsの改行が2つの空白になってしまいます。

<?php
$text = "Hello\r\nworld\nfrom\rPHP\n";

$oneLine = str_replace(["\r\n", "\r", "\n"], ' ', $text);
var_dump($oneLine);

$regex = preg_replace('/\R/', ' ', $text);
var_dump(trim($regex));

// Only the newline at the end
var_dump(rtrim("last line\n", "\r\n"));

trim()とrtrim()は文字列の両端の改行を取り除きますが、途中の改行には決して触れません。ファイルから読んだ1行には適した道具で、行をつなげるには不向きな道具です。