PHP str_contains() : savoir si une chaîne contient un texte

str_contains($haystack, $needle) renvoie true si $needle apparaît quelque part dans $haystack, et false sinon. Elle a été ajoutée en PHP 8.0 et est sensible à la casse.

<?php
$sentence = 'The quick brown fox';

var_dump(str_contains($sentence, 'quick'));   // true
var_dump(str_contains($sentence, 'Quick'));   // false: case-sensitive
var_dump(str_contains($sentence, 'dog'));     // false

if (str_contains($sentence, 'fox')) {
    echo "Found a fox\n";
}

Contrairement à strpos(), elle renvoie un vrai booléen, donc pas de piège du type « trouvé à la position 0 ressemble à false ».

Syntaxe

str_contains(string $haystack, string $needle): bool
str_starts_with(string $haystack, string $needle): bool
str_ends_with(string $haystack, string $needle): bool

Les trois ont été ajoutées en PHP 8.0 et travaillent octet par octet, elles gèrent donc correctement le japonais et les autres textes UTF-8 sans version mb_.

Vérifier le début ou la fin avec str_starts_with et str_ends_with

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

var_dump(str_starts_with($url, 'https://'));   // true
var_dump(str_ends_with($url, '.pdf'));         // true
var_dump(str_ends_with($url, '.PDF'));         // false

$name = '株式会社コディ';
var_dump(str_starts_with($name, '株式会社'));   // true

Contient, sans tenir compte de la casse

Il n'existe pas de str_icontains(). Mettez d'abord les deux chaînes en minuscules. mb_strtolower() met aussi en minuscules les lettres hors ASCII, comme É ou le cyrillique, que strtolower() laisse telles quelles.

<?php
function containsIgnoreCase(string $haystack, string $needle): bool
{
    return str_contains(mb_strtolower($haystack), mb_strtolower($needle));
}

var_dump(containsIgnoreCase('Learning PHP', 'php'));       // true
var_dump(containsIgnoreCase('ÉCOLE DE CODE', 'école'));    // true

// The same check with stripos (ASCII letters only)
var_dump(stripos('Learning PHP', 'php') !== false);        // true

L'aiguille vide renvoie true

Une aiguille vide est trouvée dans toute chaîne, y compris une chaîne vide. Cela compte quand l'aiguille vient d'un champ de recherche que l'utilisateur a laissé vide.

<?php
var_dump(str_contains('abc', ''));    // true
var_dump(str_contains('', ''));       // true

$search = '';   // a blank search field
$title = 'PHP str_contains';
$matches = $search !== '' && str_contains($title, $search);
var_dump($matches);

Vérifier si une chaîne contient l'un ou tous de plusieurs mots

str_contains() prend une seule aiguille. Bouclez sur un tableau d'aiguilles : renvoyez dès qu'une correspond pour « l'un », ou dès qu'une échoue pour « tous ».

<?php
function containsAny(string $haystack, array $needles): bool
{
    foreach ($needles as $needle) {
        if (str_contains($haystack, $needle)) {
            return true;
        }
    }
    return false;
}

function containsAll(string $haystack, array $needles): bool
{
    foreach ($needles as $needle) {
        if (!str_contains($haystack, $needle)) {
            return false;
        }
    }
    return true;
}

$comment = 'Buy cheap watches now';

var_dump(containsAny($comment, ['cheap', 'free', 'winner']));   // true
var_dump(containsAll($comment, ['cheap', 'free']));             // false

Pour vérifier si une valeur est l'un des éléments d'un tableau, et non une sous-chaîne d'une chaîne, utilisez in_array().

Avant PHP 8 : strpos !== false

Le code qui doit tourner en PHP 7 utilise strpos() avec une comparaison stricte. Il donne la même réponse que str_contains(), sauf pour une aiguille vide : strpos() en PHP 7 affichait Warning: strpos(): Empty needle et renvoyait false.

<?php
$haystack = 'php is fun';

var_dump(str_contains($haystack, 'php'));       // PHP 8
var_dump(strpos($haystack, 'php') !== false);   // PHP 7 and later

// The bug to avoid: position 0 is falsy
var_dump((bool) strpos($haystack, 'php'));

La dernière ligne affiche bool(false) alors que le texte est présent, car php se trouve à la position 0. Remplacer ces tests par str_contains() est l'une des mises à niveau PHP 8 les plus faciles.