PHP strpos() : trouver la position d'une sous-chaîne

strpos($haystack, $needle) renvoie la position du premier $needle dans $haystack, comptée depuis 0, ou false s'il n'y est pas. Testez toujours le résultat avec !== false, car une correspondance au début renvoie 0.

<?php
$text = 'apple, banana, cherry';

var_dump(strpos($text, 'banana'));   // found at position 7
var_dump(strpos($text, 'apple'));    // found at position 0
var_dump(strpos($text, 'grape'));    // not found

if (strpos($text, 'apple') !== false) {
    echo "Found apple\n";
}

Si vous n'avez besoin que d'une réponse oui ou non en PHP 8, str_contains() est plus claire. Utilisez strpos() quand la position compte.

Syntaxe

strpos(string $haystack, string $needle, int $offset = 0): int|false

La recherche est sensible à la casse. $offset indique où commencer à chercher ; un offset négatif compte depuis la fin de la chaîne.

Le piège de !== false

0 et false sont égaux en comparaison souple (==). Une correspondance à la position 0 est donc traitée comme « non trouvé » par tout test qui n'est pas strict.

<?php
$url = 'https://example.com';

// Wrong: position 0 is falsy, so this says "no"
if (strpos($url, 'https')) {
    echo "wrong check: has https\n";
} else {
    echo "wrong check: no https\n";
}

// Right: compare strictly with false
if (strpos($url, 'https') !== false) {
    echo "right check: has https\n";
}

La même règle s'applique à stripos(), strrpos() et array_search(), qui peuvent toutes renvoyer 0 pour une vraie correspondance.

Recherche insensible à la casse avec stripos

stripos() prend les mêmes arguments et ignore la casse des lettres ASCII.

<?php
$title = 'Learning PHP the Hard Way';

var_dump(strpos($title, 'php'));    // case-sensitive: not found
var_dump(stripos($title, 'php'));   // found at 9

Trouver la dernière occurrence avec strrpos

strrpos() renvoie la position de la dernière correspondance. C'est la façon standard d'obtenir l'extension d'un fichier ou le dernier segment d'un chemin.

<?php
$file = 'archive.backup.tar.gz';

$dot = strrpos($file, '.');
echo substr($file, $dot + 1), "\n";      // gz
echo substr($file, 0, $dot), "\n";       // archive.backup.tar

$path = '/var/www/html/index.php';
echo substr($path, strrpos($path, '/') + 1), "\n";

Pour les noms de fichiers en particulier, pathinfo($file, PATHINFO_EXTENSION) le fait pour vous. Couper la chaîne à la position trouvée est expliqué sur la page substr().

Commencer la recherche à un offset

Le troisième argument saute le début de la chaîne. Un offset négatif commence autant de caractères avant la fin.

<?php
$s = 'one two one two';

var_dump(strpos($s, 'one'));        // 0
var_dump(strpos($s, 'one', 1));     // skip position 0: finds the second one
var_dump(strpos($s, 'two', -3));    // search only the last 3 characters

Trouver toutes les occurrences

strpos() trouve une correspondance. Bouclez et déplacez l'offset après chaque correspondance pour les trouver toutes :

<?php
$text = 'the cat sat on the mat with the hat';
$needle = 'the';

$positions = [];
$offset = 0;
while (($pos = strpos($text, $needle, $offset)) !== false) {
    $positions[] = $pos;
    $offset = $pos + strlen($needle);
}

print_r($positions);
echo count($positions), " matches\n";

Seulement le nombre ? substr_count($text, 'the') est plus court. Pour des motifs, preg_match_all() avec PREG_OFFSET_CAPTURE renvoie chaque correspondance avec sa position.

Texte japonais : position en octets ou en caractères

strpos() trouve correctement du texte multioctet, mais le nombre qu'elle renvoie est en octets. Les kana et les kanji courants occupent 3 octets chacun en UTF-8, donc dans un texte entièrement japonais la position en octets vaut trois fois la position en caractères, et dans un texte mélangé les deux s'écartent de façon moins évidente. mb_strpos() renvoie des caractères, ce qu'attend mb_substr().

<?php
$s = '東京都渋谷区';

var_dump(strpos($s, '渋谷'));      // byte position
var_dump(mb_strpos($s, '渋谷'));   // character position

echo mb_substr($s, mb_strpos($s, '渋谷')), "\n";

Mélanger les deux est un bug classique : passer un résultat de strpos() à mb_substr() commence trop loin dans la chaîne. Utilisez strpos avec substr, et mb_strpos avec mb_substr.