iconv_strpos

(PHP 5, PHP 7, PHP 8)

iconv_strpos文字列が最初に現れる場所を見つける

説明

iconv_strpos(
    string $haystack,
    string $needle,
    int $offset = 0,
    ?string $encoding = null
): int|false

needlehaystack の中で最初に現れる位置を探します。

strpos() の戻り値は needle が見つかった位置の 先頭からのバイト数でしたが、それとは異なり iconv_strpos() の戻り値は needle が見つかった 位置の先頭からの文字数となります。文字数は encoding で指定された文字セットに基づいて 数えられます。

パラメータ

haystack

文字列全体。

needle

検索する文字列。

offset

オプションの offset パラメータは 検索を開始する位置を指定します。 負のオフセットは、文字列の末尾からのオフセットと解釈されます。

encoding

encoding パラメータが指定されなかった場合、もしくは null の場合、 string のエンコードは iconv.internal_encoding であると判断されます。

haystackneedle が文字列でない場合、文字列に変換され、文字が並んだ値として適用されます。

戻り値

needlehaystack の中で最初に現れる位置を探します。

もし needle が見つからなかった場合、 iconv_strpos()false を返します。

警告

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

変更履歴

バージョン 説明
8.0.0 encoding は、nullable になりました。
7.1.0 負の offset をサポートするようになりました。

参考

  • strpos() - 文字列内の部分文字列が最初に現れる場所を見つける
  • iconv_strrpos() - 文字列が最後に現れる場所を見つける
  • mb_strpos() - 文字列の中に指定した文字列が最初に現れる位置を見つける

関連キーワード:  最初, 場所, iconv, strpos, 位置, encoding, haystack, string, offset, 関数