PHPのstr_contains()：文字列が含まれているか判定する

str_contains($haystack, $needle)は、$needleが$haystackのどこかに現れればtrueを、そうでなければfalseを返します。PHP 8.0で追加され、大文字小文字を区別します。

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

strpos()と違って本物の真偽値を返すので、「位置0で見つかるとfalseに見える」という罠がありません。

構文

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

3つともPHP 8.0で追加され、バイト単位で動くので、mb_版がなくても日本語などのUTF-8テキストを正しく扱えます。

str_starts_withと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

大文字小文字を区別しない判定

str_icontains()はありません。先に両方の文字列を小文字にします。mb_strtolower()は、strtolower()がそのままにするÉやキリル文字のようなASCII以外の文字も小文字にします。

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

空の探す文字列はtrueを返す

空の探す文字列は、空文字列も含め、どんな文字列の中にも見つかります。ユーザーが空のままにした検索欄から探す文字列が来る場合に問題になります。

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

複数の単語のいずれか、またはすべてを含むか確認する

str_contains()が受け取る探す文字列は1つです。探す文字列の配列をループし、「いずれか」なら1つ一致した時点で、「すべて」なら1つ失敗した時点で返します。

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

文字列の部分文字列ではなく、値が配列の要素の1つかどうかを確認するには、in_array()を使います。

PHP 8より前：strpos !== false

PHP 7で動く必要があるコードは、strpos()を厳密な比較と組み合わせて使います。空の探す文字列を除けば、str_contains()と同じ答えになります。PHP 7のstrpos()は、空の探す文字列に対してWarning: strpos(): Empty needleを表示して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'));

テキストはあるのに、phpは位置0にあるので、最後の行はbool(false)を表示します。このような判定をstr_contains()に置き換えるのは、もっとも簡単なPHP 8へのアップグレードの1つです。