PHPのmb_eregi_replace()関数とは？構文・パラメータ・使用例を徹底解説

PHPのmb_eregi_replace()は、マルチバイト文字に対応した正規表現による置換を行う関数で、大文字・小文字を区別せずに処理を実行できるのが特徴です。対象の文字列の中から指定したパターンに一致する部分を検索し、見つかったテキストを別の文字列に置き換えます。この関数はPHP 4.2以降で利用できます。

なお注意点として、mb_eregi_replace()はPHP 7.3で非推奨となり、PHP 8では削除されました。新規の開発では、preg_replace()を大文字小文字を無視する「i」修飾子およびマルチバイト対応の「u」修飾子と組み合わせて使うことが推奨されます。

構文

string mb_eregi_replace(string $pattern, string $replacement, string $string, ?string $options = null)

パラメータ

mb_eregi_replace()は、以下の4つの引数を受け取ります。

• $pattern − 正規表現パターンを指定します。マルチバイト文字を使用することもでき、大文字・小文字の違いは無視されます。

• $replacement − 置換後のテキストを指定します。

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

• $options − 検索オプションを指定します。「i」（大文字小文字を無視）や「x」（拡張正規表現）などを組み合わせて設定できます。

戻り値

mb_eregi_replace()は、処理が成功した場合には置換後の文字列を返します。一方、文字列が現在の内部エンコーディングとして不正な場合などにはエラーを返します。

使用例

次のコードでは、文字列「pHp Tutorial」に含まれる小文字の「p」を大文字の「P」に置き換えています。

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

   // mb_eregi_replace()で「p」を「P」に置換
   $string = mb_eregi_replace("[p]", "P", "pHp Tutorial");

   var_dump($re);
   var_dump($string);
?>

実行結果

bool(true)
string(12) "PHP Tutorial"

このように、大文字・小文字が混在した「pHp」という文字列でも、すべての「p」「P」が一括して大文字「P」に置き換えられ、「PHP Tutorial」という結果が得られます。日本語などのマルチバイト文字列を扱う際にも安心して使えるのが、この系統のmb_*関数の利点です。