PHP substr() : extraire une partie d'une chaîne

substr($string, $offset, $length) renvoie la partie de $string qui commence à la position $offset (comptée depuis 0) et fait $length caractères. substr('Hello world', 0, 5) renvoie "Hello". Omettez $length pour tout obtenir jusqu'à la fin.

<?php
$s = 'Hello world';

echo substr($s, 0, 5), "\n";   // from the start, 5 characters
echo substr($s, 6), "\n";      // from position 6 to the end
echo substr($s, 4, 3), "\n";   // 3 characters from position 4

substr() compte des octets. C'est la même chose que des caractères pour du texte anglais, mais pas pour le japonais, le chinois, les emoji ou les lettres accentuées. Pour ceux-là, utilisez mb_substr(), présentée plus bas.

Syntaxe

substr(string $string, int $offset, ?int $length = null): string

• $offset est l'endroit où commencer. 0 est le premier caractère. Une valeur négative compte depuis la fin.
• $length est le nombre d'octets à prendre (un octet vaut un caractère en texte ASCII simple). Une valeur négative en laisse autant à la fin. null (ou l'omettre) signifie « jusqu'à la fin ».

Position et longueur négatives : travailler depuis la fin

Une $offset négative commence à compter depuis la fin de la chaîne, donc -1 est le dernier caractère. Une $length négative s'arrête autant de caractères avant la fin.

<?php
$file = 'report-2026.pdf';

echo substr($file, -3), "\n";       // last 3 characters
echo substr($file, -8, 4), "\n";    // 4 characters, starting 8 from the end
echo substr($file, 0, -4), "\n";    // everything except the last 4
echo substr($file, 7, -4), "\n";    // from position 7, minus the last 4

substr($s, 0, -1) est la façon habituelle de supprimer le dernier caractère, par exemple une virgule finale laissée par une boucle.

Obtenir le premier ou le dernier caractère

Pour un seul octet, vous pouvez aussi indexer directement la chaîne. $s[0] est le premier caractère et, depuis PHP 7.1, $s[-1] le dernier.

<?php
$word = 'banana';

echo substr($word, 0, 1), ' ', $word[0], "\n";    // first character
echo substr($word, -1), ' ', $word[-1], "\n";     // last character
echo substr($word, 1), "\n";                     // drop the first character

Indexer une position qui n'existe pas affiche un warning, alors que substr() renvoie simplement une chaîne vide. Si la chaîne peut être vide, préférez substr().

Hors limites : une chaîne vide, pas false

Si $offset dépasse la fin de la chaîne, substr() renvoie "" en PHP 8. En PHP 7, elle renvoyait false, donc du code ancien qui teste === false ne fonctionne plus.

<?php
var_dump(substr('abc', 5));       // start past the end
var_dump(substr('abc', 1, 100));  // length longer than the rest is fine
var_dump(substr('abc', -10));     // negative offset before the start: from 0

Texte japonais : utiliser mb_substr

L'UTF-8 stocke les kana et les kanji courants sur 3 octets chacun (les kanji rares comme 𠮷 et les emoji en prennent 4). substr() compte des octets, donc substr('こんにちは', 0, 3) ne renvoie que こ, et une longueur qui ne tombe pas sur une limite de caractère coupe un caractère en deux et produit du texte cassé. mb_substr() prend les mêmes arguments et compte des caractères.

<?php
$greeting = 'こんにちは世界';

echo substr($greeting, 0, 3), "\n";       // 3 bytes = 1 character
echo mb_substr($greeting, 0, 3), "\n";    // 3 characters
echo mb_substr($greeting, -2), "\n";      // last 2 characters

// Cutting at 4 bytes splits a character: the result is not valid UTF-8
var_dump(mb_check_encoding(substr($greeting, 0, 4), 'UTF-8'));

C'est pareil pour les emoji et les lettres accentuées comme é. Pour compter des caractères, utilisez mb_strlen() ; voir strlen() pour la différence entre octets et caractères.

Raccourcir un texte avec des points de suspension

Couper un long titre pour une liste ou une carte est l'usage réel le plus courant de substr(). Utilisez mb_substr() pour qu'un titre japonais ne soit jamais coupé au milieu d'un caractère, et n'ajoutez ... que si vous avez vraiment raccourci quelque chose.

<?php
function excerpt(string $text, int $max): string
{
    if (mb_strlen($text) <= $max) {
        return $text;
    }
    return rtrim(mb_substr($text, 0, $max)) . '...';
}

echo excerpt('Short title', 20), "\n";
echo excerpt('A much longer title that will not fit in the card', 20), "\n";
echo excerpt('東京から大阪までの新幹線の旅', 8), "\n";

mb_strimwidth($text, 0, $width, '...') fait la même chose selon la largeur d'affichage, où un caractère japonais pleine chasse compte pour 2 colonnes et une lettre latine pour 1. Elle convient aux mises en page à largeur fixe.

Compter une sous-chaîne avec substr_count

substr_count($haystack, $needle) renvoie combien de fois $needle apparaît. Elle est sensible à la casse et ne compte pas les correspondances qui se chevauchent.

<?php
echo substr_count('banana', 'an'), "\n";
echo substr_count('aaaa', 'aa'), "\n";      // 2, not 3: no overlaps
echo substr_count('Hello hello', 'hello'), "\n";
echo substr_count(strtolower('Hello hello'), 'hello'), "\n";

substr avec strpos : le texte avant ou après un caractère

Combinez substr() avec strpos() pour couper à un caractère dont vous ne connaissez pas la position à l'avance, comme le @ d'une adresse email :

<?php
$email = 'ada.lovelace@example.com';
$at = strpos($email, '@');

echo substr($email, 0, $at), "\n";    // before the @
echo substr($email, $at + 1), "\n";   // after the @

// strstr does the same in one call
echo strstr($email, '@', true), "\n";

Vérifiez que strpos() n'a pas renvoyé false avant d'utiliser son résultat : si le caractère manque, false est traité comme 0 sans warning, donc substr('nobody', 0, $at) renvoie "" et substr('nobody', $at + 1) renvoie "obody".