Retour à la ligne en PHP : \n, PHP_EOL et nl2br

Écrivez \n dans une chaîne entre guillemets doubles pour afficher un retour à la ligne : echo "Line 1\nLine 2";. La constante PHP_EOL fait la même chose et se lit plus clairement en fin de ligne : echo 'Done' . PHP_EOL;. Dans une page web, un saut de ligne ne s'affiche pas comme tel ; il vous faut alors <br> ou nl2br().

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

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

Guillemets simples ou doubles

Les séquences d'échappement comme \n et \t ne fonctionnent qu'entre guillemets doubles. Entre guillemets simples, '\n' fait deux caractères : une barre oblique inverse et la lettre n. C'est la raison habituelle du « \n ne fonctionne pas ».

<?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;

La page sur les chaînes liste toutes les séquences d'échappement que comprennent les guillemets doubles.

PHP_EOL ou "\n"

PHP_EOL est la fin de ligne du système sur lequel tourne PHP : "\n" sur Linux et macOS, "\r\n" sur Windows. Utilisez-la pour la sortie terminal et pour des fichiers que vous lirez sur la même machine. Quand un format définit sa propre fin de ligne, utilisez-la plutôt : les en-têtes HTTP et les emails exigent "\r\n", et la plupart des outils lisent "\n" sans problème partout.

<?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" est un retour chariot, "\n" un saut de ligne. Les fichiers Windows terminent les lignes par les deux, "\r\n", c'est pourquoi un texte venant d'un utilisateur Windows ou d'un <textarea> contient souvent des caractères \r inattendus.

Retour à la ligne en HTML : br et nl2br

Un navigateur réduit les sauts de ligne à un seul espace, donc echo "a\nb" affiche a b sur une page. Affichez vous-même <br>, ou gardez les sauts de ligne dans votre texte et convertissez-les avec nl2br(), qui insère <br /> avant chacun. Exécutez ceci et comparez les onglets Output et 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";

Dans l'onglet Output, les trois se ressemblent. Dans l'onglet Page, le premier tient sur une seule ligne, nl2br() le découpe, et <pre> garde les sauts de ligne tels qu'ils sont écrits.

Afficher une saisie de textarea avec ses sauts de ligne

Le texte d'un <textarea> garde les lignes tapées par l'utilisateur, mais vous devez l'échapper avant de l'afficher dans du HTML. L'ordre compte : htmlspecialchars() d'abord, puis nl2br(), sinon les balises <br /> elles-mêmes seraient échappées. Exécutez-le, tapez quelques lignes dans la zone et cliquez sur Preview : le même script s'exécute à nouveau avec $_POST rempli.

<?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; ?>

Un saut de ligne de textarea peut arriver sous la forme "\r\n" ou "\n" ; les deux contiennent "\n", donc compter ce caractère fonctionne dans les deux cas. htmlspecialchars() explique pourquoi l'échappement n'est pas facultatif ici.

Découper une chaîne par ligne

explode("\n", $text) fonctionne pour un texte que vous avez créé vous-même. Pour du texte venant d'utilisateurs ou de fichiers, les fins de ligne peuvent être "\r\n", "\n" ou "\r" ; preg_split('/\R/', $text) les gère toutes, car \R correspond à n'importe quel saut de ligne.

<?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));

Supprimer les sauts de ligne d'une chaîne

Pour transformer un texte sur plusieurs lignes en une seule ligne, remplacez chaque type de fin de ligne. Remplacez "\r\n" avant les caractères seuls, sinon chaque saut de ligne Windows deviendrait deux espaces :

<?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() et rtrim() suppriment les sauts de ligne aux extrémités d'une chaîne mais jamais au milieu, c'est donc le bon outil pour une ligne lue dans un fichier et le mauvais pour réunir des lignes.