strpos
(PHP 4, PHP 5, PHP 7)
strpos — 文字列内の部分文字列が最初に現れる場所を見つける
説明
strpos
( 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
- 指定すると、文字列内での検索開始位置がその位置になります。 負の数を指定すると、文字列の末尾からこの数だけ戻った場所から検索を開始します。
返り値
needle が見つかった位置を、
haystack
文字列の先頭 (offset の値とは無関係) からの相対位置で返します。
文字列の開始位置は 0 であり、1 ではないことに注意しましょう。
needle が見つからない場合は false
を返します。
変更履歴
バージョン | 説明 |
---|---|
8.0.0 | needle に数値を渡すことはサポートされなくなりました。
|
7.3.0 | needle に数値を渡すことは非推奨になりました。
|
7.1.0 | 負の offset をサポートするようになりました。
|
例
例1 ===
の使用
<?php$mystring = 'abc';$findme = 'a';$pos = strpos($mystring, $findme);// === を使用していることに注目しましょう。単純に == を使ったのでは// 期待通りに動作しません。なぜなら 'a' が 0 番目 (最初) の文字だからです。if ($pos === false) { echo "文字列 '$findme' は、文字列 '$mystring' の中で見つかりませんでした";} else { echo "文字列 '$findme' が文字列 '$mystring' の中で見つかりました"; echo " 見つかった位置は $pos です";}?>
例2 !== の使用
<?php$mystring = 'abc';$findme = 'a';$pos = strpos($mystring, $findme);// !== 演算子も使用可能です。ここで != を使っても期待通りに動作しません。// なぜなら 'a' が 0 番目の文字だからです。(0 != false) を評価すると// false になってしまいます。if ($pos !== false) { echo "文字列 '$findme' が文字列 '$mystring' の中で見つかりました"; echo " 見つかった位置は $pos です";} else { echo "文字列 '$findme' は、文字列 '$mystring' の中で見つかりませんでした";}?>
例3 オフセットの使用
<?php// オフセット以前の内容を無視して文字を探すこともできます。$newstring = 'abcdef abcdef';$pos = strpos($newstring, 'a', 1); // $pos は 0 ではなく 7 となります。?>
注意
注意:
この関数はバイナリデータに対応しています。
参考
- stripos() - 大文字小文字を区別せずに文字列が最初に現れる位置を探す
- str_contains() - 指定された部分文字列が、文字列に含まれるかを調べる
- str_ends_with() - 文字列が、指定された文字列で終わるかを調べる。
- str_starts_with() - 文字列が指定された部分文字列で始まるかを調べる
- strrpos() - 文字列中に、ある部分文字列が最後に現れる場所を探す
- strripos() - 文字列中で、特定の(大文字小文字を区別しない)文字列が最後に現れた位置を探す
- strstr() - 文字列が最初に現れる位置を見つける
- strpbrk() - 文字列の中から任意の文字を探す
- substr() - 文字列の一部分を返す
- preg_match() - 正規表現によるマッチングを行う