PHPのstrpos()：文字列の位置を検索する

strpos($haystack, $needle)は、$haystackの中で最初に現れる$needleの位置を0から数えて返し、なければfalseを返します。先頭での一致は0を返すので、結果は必ず!== falseで判定します。

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

PHP 8で、あるかないかだけがわかればよいなら、str_contains()のほうがわかりやすく書けます。位置が重要なときにstrpos()を使います。

構文

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

検索は大文字小文字を区別します。$offsetは検索を始める場所を指定し、負のオフセットは文字列の末尾から数えます。

!== falseの落とし穴

0とfalseは、ゆるい比較（==）では等しくなります。そのため、厳密でない判定では、位置0の一致が「見つからない」として扱われます。

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

同じルールは、本当の一致に対して0を返しうるstripos()、strrpos()、array_search()にも当てはまります。

striposで大文字小文字を区別せずに検索する

stripos()は同じ引数を受け取り、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

strrposで最後の出現を見つける

strrpos()は最後の一致の位置を返します。ファイルの拡張子やパスの最後の部分を取得する標準的な方法です。

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

ファイル名に限れば、pathinfo($file, PATHINFO_EXTENSION)がこれをやってくれます。位置で文字列を切る方法はsubstr()のページで扱っています。

オフセットから検索を始める

3つ目の引数は文字列の先頭を飛ばします。負のオフセットは、末尾からその文字数だけ手前から始めます。

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

すべての出現を見つける

strpos()が見つけるのは1つの一致です。ループして各一致の後ろにオフセットを動かせば、すべてを見つけられます。

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

数だけが必要なら、substr_count($text, 'the')のほうが短く書けます。パターンなら、PREG_OFFSET_CAPTUREを指定したpreg_match_all()がすべての一致を位置付きで返します。

日本語のテキスト：バイト位置と文字位置

strpos()はマルチバイトのテキストも正しく見つけますが、返す数値はバイト単位です。UTF-8ではかなとよく使う漢字は1文字3バイトなので、日本語だけのテキストではバイト位置は文字位置の3倍になり、混在したテキストではもっとわかりにくい形でずれていきます。mb_strpos()は文字単位で返し、これが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";

2つを混ぜるのは定番のバグで、strpos()の結果をmb_substr()に渡すと文字列の奥から始まりすぎてしまいます。strposはsubstrと、mb_strposはmb_substrと組み合わせて使いましょう。