PHP – mb_ereg_search_init()関数の使い方を徹底解説

PHPのmb_ereg_search_init()関数は、マルチバイト正規表現によるマッチング処理を行うための準備として、検索対象の文字列と正規表現パターンを事前に設定するために使用されます。ここで設定された値は、mb_ereg_search_regs()、mb_ereg_search_pos()、mb_ereg_search()といった関連関数から利用されます。

つまり、この関数はマルチバイト文字列に対する正規表現検索の「初期化」役割を担っており、日本語などのマルチバイト文字を扱う際に非常に重要な関数です。

構文

bool mb_ereg_search_init(
   $str_string,
   $str_pattern = null,
   $str_options = null
)

パラメータ

mb_ereg_search_init()関数は、以下の3つの引数を受け取ります。

• $str_string（文字列） − 正規表現検索の対象となる文字列を指定します。

• $str_pattern（パターン） − マッチングに使用する正規表現パターンを指定します。

• $str_options（オプション） − 検索時のオプションを指定します。省略可能です。

戻り値

mb_ereg_search_init()関数は、設定が正常に完了した場合にtrueを、失敗した場合にはfalseを返します。

使用例

以下の例では、まず内部エンコーディングをUTF-8に設定し、その後に文字列「PHP online tutorial」に対して正規表現パターン「[l]」を用いて検索の初期化を行っています。

<?php
   // 内部エンコーディングをUTF-8に設定
   $encoding = mb_regex_encoding("UTF-8");

   // 文字列 "PHP online tutorial" に対してパターン "[l]" で初期化
   $bool = mb_ereg_search_init("PHP online tutorial", "[l]");
   var_dump($bool);
   var_dump($encoding);
?>

実行結果

bool(true)
bool(true)

このように、両方のvar_dump()の出力がbool(true)となっており、エンコーディングの設定と検索の初期化がそれぞれ正常に行われたことが確認できます。