mb_ereg_search_init

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

mb_ereg_search_initマルチバイト正規表現検索用の文字列と正規表現を設定する

説明

mb_ereg_search_init(string $string, ?string $pattern = null, ?string $options = null): bool

mb_ereg_search_init() は、マルチバイト対応の正規 表現検索において検索対象の文字列 string および正規表現 pattern を設定します。 この設定は、mb_ereg_search(), mb_ereg_search_pos(), mb_ereg_search_regs() で使用されます。

パラメータ

string

検索文字列。

pattern

検索パターン。

options

検索オプション。説明は、mb_regex_set_options() を参照してください。

戻り値

成功した場合に true を、失敗した場合に false を返します。

変更履歴

バージョン 説明
8.0.0 patternoptions は、nullable になりました。

注意

注意:

内部エンコーディングあるいは mb_regex_encoding() で指定した文字エンコーディングを、 この関数の文字エンコーディングとして使用します。

参考

  • mb_regex_encoding() - 現在のマルチバイト正規表現用のエンコーディングを取得または設定する
  • mb_ereg_search_regs() - 指定したマルチバイト文字列が正規表現に一致する部分を取得する

関連キーワード:  検索, 設定, ereg, search, マルチ, バイト, string, pattern, init, 関数