説明

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

文字列 haystack の中で、 needle が最後に現れる位置を探します。

パラメータ

haystack

検索対象の文字列。

needle

検索する文字列。

PHP 8.0.0 より前のバージョンでは、needle が文字列でない場合、数値に変換され、文字のコードポイントとして扱われていました。この振る舞いは PHP 7.3.0 以降では推奨されないので、この機能を使用しないことを強く推奨します。意図する動作に応じて、 needle を string に明示的にキャストするか、明示的に chr() 関数を呼び出すべきでしょう。

offset

ゼロまたは正の値の場合、 haystack の最初の offset バイトをスキップし、左から右に検索が行われます。

負の値の場合、 haystack の最初ではなく、最後から offset バイトの箇所より検索を開始します。検索は右から左に行われ、検索を開始した箇所から needle が最初に現れる場所を探します。

注意:
この方が、最後の offset バイト、またはそれより前にある最後の needle を効率的に探せます。

戻り値

needle が見つかった位置を、 haystack 文字列の先頭 (offset の値とは無関係) からの相対位置で返します。

注意: 文字列の開始位置は 0 であり、1 ではありません。

needle が見つからない場合は false を返します。

警告

この関数は論理値 false を返す可能性がありますが、false として評価される値を返す可能性もあります。詳細については論理値のセクションを参照してください。この関数の返り値を調べるには ===演算子を使用してください。

エラー / 例外

offset が haystack の長さより大きい場合、 ValueError がスローされます。

変更履歴

バージョン	説明
8.0.0	`needle` は、空文字列を受け入れるようになりました。
8.0.0	`needle` に数値を渡すことはサポートされなくなりました。
7.3.0	`needle` に数値を渡すことは非推奨になりました。

例

例1 needle が haystack の中にあるかどうかの確認

"位置 0 に文字が見つかった" と "文字が見つからなかった" 場合の戻り値は混同しやすいです。この違いを見分ける方法を以下に示します。

<?php
$mystring = 'Elephpant';

$pos = strrpos($mystring, "b");
if ($pos === false) { // 注意: 等号が 3 つ並んでいます
    // 見つからない...
}

?>

例2 オフセットつきの検索

<?php
$foo = "0123456789a123456789b123456789c";

// Looking for '0' from the 0th byte (from the beginning)
var_dump(strrpos($foo, '0', 0));

// Looking for '0' from the 1st byte (after byte "0")
var_dump(strrpos($foo, '0', 1));

// Looking for '7' from the 21th byte (after byte 20)
var_dump(strrpos($foo, '7', 20));

// Looking for '7' from the 29th byte (after byte 28)
var_dump(strrpos($foo, '7', 28));

// Looking for '7' right to left from the 5th byte from the end
var_dump(strrpos($foo, '7', -5));

// Looking for 'c' right to left from the 2nd byte from the end
var_dump(strrpos($foo, 'c', -2));

// Looking for '9c' right to left from the 2nd byte from the end
var_dump(strrpos($foo, '9c', -2));
?>

上の例の出力は以下となります。

int(0)
bool(false)
int(27)
bool(false)
int(17)
bool(false)
int(29)

参考

strpos() - 文字列内の部分文字列が最初に現れる場所を見つける
stripos() - 大文字小文字を区別せずに文字列が最初に現れる位置を探す
strripos() - 文字列中で、特定の(大文字小文字を区別しない)文字列が最後に現れた位置を探す
strrchr() - 文字列中に文字が最後に現れる場所を取得する
substr() - 文字列の一部分を返す