PHPのmb_ereg_replace()関数とは？マルチバイト文字対応の正規表現置換をわかりやすく解説

PHPには、mb_ereg_replace()というマルチバイト文字に対応した正規表現置換用の関数が用意されています。この関数は、対象となる文字列を走査してパターンに一致する部分を検出し、その一致したテキストを指定した置換文字列に置き換えます。日本語などのマルチバイト文字列を扱う際に非常に便利な関数です。

構文

string mb_ereg_replace(str $pattern, str $replacement, str $string, str $options)

パラメータ

この関数は、以下の4つのパラメータを受け取ります。

• $pattern − 正規表現パターンを指定します。パターン内でマルチバイト文字を使用することも可能です。

• $replacement − 一致したテキストを置き換えるための置換文字列を指定します。

• $string − 検索・置換の対象となる文字列を指定します。

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

戻り値

mb_ereg_replace()は、処理が成功した場合には置換後の文字列を返します。エラーが発生した場合はfalseを返し、また、文字列が現在のエンコーディングに対して有効でない場合にはnullを返します。

使用例

以下の例では、UTF-8エンコーディングを使用しています。mb_ereg_replace()関数によって、小文字の「h」が大文字の「H」に置き換えられ、「hello World」ではなく「Hello World」が出力されます。

<?php
   $result = mb_regex_encoding("UTF-8");
   $string = mb_ereg_replace("[h]", "H", "hello World");
   var_dump($result);

   // h が H に置き換えられる
   echo "$string";
?>

出力結果

bool(true)
Hello World

補足：mb_ereg_replace()を使う際の注意点

PHP 7.3以降では、mb_ereg_replace()のe修飾子（評価オプション）が非推奨となっているため、コールバック処理を行いたい場合は代わりにmb_ereg_replace_callback()関数を使用することが推奨されています。また、マルチバイト文字列を扱う前にmb_regex_encoding()で内部エンコーディングを明示的に設定しておくと、意図しない文字化けを防げます。