【PHP8.x】mb_ereg_match()関数の使い方
mb_ereg_match関数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
mb_ereg_match関数は、マルチバイト文字列に対して正規表現によるパターンマッチングを実行する関数です。この関数はPHPのmb_regex拡張機能の一部であり、日本語のようなマルチバイト文字を含む文字列を扱う際に、文字エンコーディングを正しく考慮して正規表現の照合を行います。これにより、標準の正規表現関数で発生しうる文字化けや意図しないマッチングを防ぎ、より正確な文字列処理を可能にします。
mb_ereg_match関数は、最初の引数に検査対象の文字列、二番目の引数に正規表現パターンを受け取ります。正規表現パターンとは、特定のルールに基づいて文字列の中から一致する部分を探し出すための記述方法です。この関数は、与えられた正規表現パターンが、検査対象の文字列全体と完全に一致するかどうかを調べます。パターンが文字列全体に完全に一致した場合にtrueを返し、一致しない場合にはfalseを返します。
さらに、三番目のオプション引数として、正規表現の挙動を制御するオプション文字列を指定できます。例えば、「大文字小文字を区別しない」ことを意味するiオプションや、複数行モードを有効にするmオプションなどがあり、これにより柔軟なマッチング条件を設定できます。この関数は、Webアプリケーションなどでユーザーからの入力値を検証したり、特定の形式のデータを抽出したりする際に、特に日本語の氏名や住所など、マルチバイト文字を含むデータを扱う場面でその真価を発揮します。システムエンジニアを目指す方にとって、マルチバイト文字列の正確な処理は重要なスキルの一つであり、この関数はその基盤となります。
構文(syntax)
1<?php 2$pattern = 'hello'; 3$string = 'Hello'; 4$options = 'i'; // オプション: 大文字小文字を区別しない 5 6$is_match = mb_ereg_match($pattern, $string, $options); 7?>
引数(parameters)
string $pattern, string $string, ?string $options = null
- string $pattern: マッチングに使用する正規表現パターン
- string $string: マッチング対象の文字列
- ?string $options = null: オプションを指定する文字列。指定しない場合はnull。
戻り値(return)
bool
正規表現パターンが文字列にマッチしたかどうかを示す真偽値を返します。マッチした場合はtrue、マッチしなかった場合はfalseを返します。
サンプルコード
PHP mb_ereg_matchで文字列全体一致を検証する
1<?php 2 3/** 4 * mb_ereg_match 関数の使用例を示します。 5 * 6 * mb_ereg_match は、POSIX拡張正規表現を使用して文字列全体がパターンにマッチするかどうかをチェックする関数です。 7 * 主にマルチバイト文字列（日本語など）の正規表現処理に使用されます。 8 * 9 * mb_ereg_match と preg_match の主な違い: 10 * - mb_ereg_match: POSIX拡張正規表現を使用し、文字列全体がパターンに完全に一致する場合にのみ true を返します。 11 * - preg_match: PCRE (Perl Compatible Regular Expressions) を使用し、部分的な一致でも true を返すことがあります 12 * （ただし、パターンを ^ と $ で囲むことで全体一致も可能です）。 13 * 14 * システムエンジニアを目指す方へ: 15 * 文字列の形式検証などで正規表現は頻繁に利用されます。 16 * 特にマルチバイト文字列を扱う際には、この `mb_ereg_match` のような `mb_` プレフィックスの付いた関数が重要になります。 17 * どちらの正規表現エンジン（POSIX EREGかPCREか）を使うか、また文字列の全体にマッチさせるか部分マッチで良いか、 18 * という点を意識して使い分けることが重要です。 19 */ 20function demonstrateMbEregMatch(): void 21{ 22 // mb_ereg系の関数は、mb_internal_encoding の設定に依存する場合があります。 23 // 日本語を扱うため、UTF-8 を設定することが一般的です。 24 mb_internal_encoding("UTF-8"); 25 26 echo "--- mb_ereg_match の基本的な使用例 ---" . PHP_EOL; 27 28 // 例1: 文字列全体がパターンに完全に一致する場合 (true) 29 $pattern1 = "Hello PHP"; 30 $string1 = "Hello PHP"; 31 $result1 = mb_ereg_match($pattern1, $string1); 32 echo "パターン: '{$pattern1}', 文字列: '{$string1}' => " . ($result1 ? "一致 (true)" : "不一致 (false)") . PHP_EOL; 33 34 // 例2: 文字列の一部しか一致しない、または異なる場合 (false) 35 // mb_ereg_match は文字列全体がパターンに一致しないと false を返します。 36 $pattern2 = "Hello PHP"; 37 $string2 = "Hello PHP 8"; // 末尾が異なるため不一致 38 $result2 = mb_ereg_match($pattern2, $string2); 39 echo "パターン: '{$pattern2}', 文字列: '{$string2}' => " . ($result2 ? "一致 (true)" : "不一致 (false)") . PHP_EOL; 40 41 // 例3: マルチバイト文字列の検証 (日本語) 42 $pattern3 = "こんにちは世界"; 43 $string3 = "こんにちは世界"; 44 $result3 = mb_ereg_match($pattern3, $string3); 45 echo "パターン: '{$pattern3}', 文字列: '{$string3}' => " . ($result3 ? "一致 (true)" : "不一致 (false)") . PHP_EOL; 46 47 $string3_fail = "こんにちは世界！"; // 末尾が異なるため不一致 48 $result3_fail = mb_ereg_match($pattern3, $string3_fail); 49 echo "パターン: '{$pattern3}', 文字列: '{$string3_fail}' => " . ($result3_fail ? "一致 (true)" : "不一致 (false)") . PHP_EOL; 50 51 // 例4: オプションの使用 - 大文字小文字を無視する 'i' オプション 52 // ereg系の正規表現では、オプションは第3引数で文字列として渡します。 53 $pattern4 = "apple"; 54 $string4 = "Apple"; // 大文字が含まれる 55 $options4 = "i"; // 'i' は大文字・小文字を無視するオプション 56 $result4 = mb_ereg_match($pattern4, $string4, $options4); 57 echo "パターン: '{$pattern4}', 文字列: '{$string4}', オプション: '{$options4}' => " . ($result4 ? "一致 (true)" : "不一致 (false)") . PHP_EOL; 58 59 $string4_fail = "Apples"; // 末尾が異なるため不一致 60 $result4_fail = mb_ereg_match($pattern4, $string4_fail, $options4); 61 echo "パターン: '{$pattern4}', 文字列: '{$string4_fail}', オプション: '{$options4}' => " . ($result4_fail ? "一致 (true)" : "不一致 (false)") . PHP_EOL; 62 63 echo PHP_EOL; 64 echo "--- mb_ereg_match と正規表現のメタ文字 ---" . PHP_EOL; 65 66 // 例5: 正規表現のメタ文字 '^' (行頭) と '$' (行末) を使った全体一致のパターン 67 // mb_ereg_match は通常、自動的に文字列全体のマッチを試みますが、明示的に指定することもできます。 68 $email_pattern = "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"; // シンプルなメールアドレスパターン 69 $email_string_valid = "test@example.com"; 70 $email_string_invalid = "test@example.com.invalid-suffix"; // ドメインの一部がパターンと異なる 71 72 $result_email_valid = mb_ereg_match($email_pattern, $email_string_valid); 73 echo "パターン: '{$email_pattern}', 文字列: '{$email_string_valid}' => " . ($result_email_valid ? "一致 (true)" : "不一致 (false)") . PHP_EOL; 74 75 $result_email_invalid = mb_ereg_match($email_pattern, $email_string_invalid); 76 echo "パターン: '{$email_pattern}', 文字列: '{$email_string_invalid}' => " . ($result_email_invalid ? "一致 (true)" : "不一致 (false)") . PHP_EOL; 77} 78 79// 関数の実行 80demonstrateMbEregMatch(); 81 82?>
PHP 8で利用可能なmb_ereg_match関数は、マルチバイト文字列（日本語など）を含む文字列が、指定されたPOSIX拡張正規表現パターンに全体として完全に一致するかどうかを検証するために使用されます。
この関数は、第1引数に正規表現パターンを表す$pattern、第2引数に検証対象の文字列$stringを取ります。そして、$string全体が$patternに完全に一致した場合にtrue（真）を、一致しない場合にfalse（偽）を戻り値として返します。第3引数にはオプションの$optionsを指定でき、例えば「i」を渡すことで大文字・小文字を区別しない一致判定を行うことができます。mb_プレフィックスが付く関数群と同様に、mb_internal_encodingの設定（通常はUTF-8など）に依存して動作します。
mb_ereg_matchは文字列全体の一致を自動的に判定する点が特徴です。類似の関数であるpreg_matchがPCRE（Perl Compatible Regular Expressions）を利用し、部分的な一致も検出できるのに対し、mb_ereg_matchはPOSIX拡張正規表現を使用し、常に文字列全体がパターンに完全に一致することを要求します。
システムエンジニアとして入力データの形式検証などを行う際、特にマルチバイト文字を含む文字列に対して、その文字列が特定のパターンに厳密に適合するかを確認したい場合に非常に有効な関数です。
mb_ereg_match関数は、マルチバイト文字列に対しPOSIX拡張正規表現を用いて、文字列全体がパターンに完全に一致するかを判定します。preg_matchとは異なり、デフォルトで文字列全体のマッチングを試みるため、部分一致ではfalseを返します。この挙動の違いは特に注意が必要です。マルチバイト文字列を正しく処理するためには、mb_internal_encoding関数で適切な文字エンコーディング（例えば"UTF-8"）を設定しておくことが重要です。大文字小文字の区別を無視する「i」などのオプションは、第3引数に文字列として渡します。mb_プレフィックスの付く関数はマルチバイト対応ですが、PHPではPCREベースのpreg_match関数族がより広く推奨される傾向にあることも覚えておくと良いでしょう。
PHP mb_ereg_matchで文字列完全一致を判定する
1<?php 2 3/** 4 * 文字列が指定された正規表現に完全にマッチするかどうかをチェックします。 5 * 6 * mb_ereg_match は、PCRE (preg_match など) とは異なり、文字列全体がパターンに 7 * マッチするかどうかを判定します。部分一致ではなく、完全一致が求められます。 8 * また、多バイト文字に対応しています。 9 * 10 * @param string $pattern チェックする正規表現パターン。 11 * @param string $string チェック対象の文字列。 12 * @param ?string $options オプション文字列 (例: 'i'で大文字小文字を区別しない)。 13 * 'i': 大文字小文字を区別しない 14 * 'm': マルチラインモード 15 * 'x': 拡張パターン形式 (空白やコメントを無視) 16 * @return bool 文字列全体がパターンにマッチすればtrue、そうでなければfalse。 17 */ 18function checkStringFullMatch(string $pattern, string $string, ?string $options = null): bool 19{ 20 // mb_ereg_* 関数を使用する前に、内部エンコーディングを設定することが推奨されます。 21 // これにより、多バイト文字が正しく処理されることが保証されます。 22 // 日本語を扱う場合は、UTF-8 を設定することが一般的です。 23 mb_internal_encoding("UTF-8"); 24 25 return mb_ereg_match($pattern, $string, $options); 26} 27 28// --- サンプル使用例 --- 29 30echo "--- mb_ereg_match の基本的な使用例 ---" . PHP_EOL . PHP_EOL; 31 32// 例1: 数字のみの文字列の完全一致 33$pattern1 = "^[0-9]+$"; // ^ と $ は文字列の開始と終了を示す 34$string1_1 = "12345"; 35$string1_2 = "abc123"; 36$string1_3 = "123-45"; 37 38echo "パターン: '{$pattern1}'" . PHP_EOL; 39echo " 文字列: '{$string1_1}' -> " . (checkStringFullMatch($pattern1, $string1_1) ? "マッチ" : "不一致") . PHP_EOL; // マッチ 40echo " 文字列: '{$string1_2}' -> " . (checkStringFullMatch($pattern1, $string1_2) ? "マッチ" : "不一致") . PHP_EOL; // 不一致 41echo " 文字列: '{$string1_3}' -> " . (checkStringFullMatch($pattern1, $string1_3) ? "マッチ" : "不一致") . PHP_EOL; // 不一致 (ハイフンが含まれるため) 42echo PHP_EOL; 43 44// 例2: 多バイト文字（日本語）を含む文字列の完全一致 45$pattern2 = "^[あ-ん]+$"; // ひらがなのみの文字列 46$string2_1 = "こんにちは"; 47$string2_2 = "Hello世界"; // 半角英字と漢字が含まれる 48$string2_3 = "ありがとう。"; // 句読点が含まれる 49 50echo "パターン: '{$pattern2}'" . PHP_EOL; 51echo " 文字列: '{$string2_1}' -> " . (checkStringFullMatch($pattern2, $string2_1) ? "マッチ" : "不一致") . PHP_EOL; // マッチ 52echo " 文字列: '{$string2_2}' -> " . (checkStringFullMatch($pattern2, $string2_2) ? "マッチ" : "不一致") . PHP_EOL; // 不一致 53echo " 文字列: '{$string2_3}' -> " . (checkStringFullMatch($pattern2, $string2_3) ? "マッチ" : "不一致") . PHP_EOL; // 不一致 (句読点が含まれるため) 54echo PHP_EOL; 55 56// 例3: オプション 'i' (大文字小文字を区別しない) の使用 57$pattern3 = "^php$"; 58$string3_1 = "php"; 59$string3_2 = "PHP"; 60$string3_3 = "Php"; 61 62echo "パターン: '{$pattern3}' (オプションなし)" . PHP_EOL; 63echo " 文字列: '{$string3_1}' -> " . (checkStringFullMatch($pattern3, $string3_1) ? "マッチ" : "不一致") . PHP_EOL; // マッチ 64echo " 文字列: '{$string3_2}' -> " . (checkStringFullMatch($pattern3, $string3_2) ? "マッチ" : "不一致") . PHP_EOL; // 不一致 65echo " 文字列: '{$string3_3}' -> " . (checkStringFullMatch($pattern3, $string3_3) ? "マッチ" : "不一致") . PHP_EOL; // 不一致 66echo PHP_EOL; 67 68echo "パターン: '{$pattern3}' ('i' オプション: 大文字小文字を区別しない)" . PHP_EOL; 69echo " 文字列: '{$string3_1}' -> " . (checkStringFullMatch($pattern3, $string3_1, 'i') ? "マッチ" : "不一致") . PHP_EOL; // マッチ 70echo " 文字列: '{$string3_2}' -> " . (checkStringFullMatch($pattern3, $string3_2, 'i') ? "マッチ" : "不一致") . PHP_EOL; // マッチ 71echo " 文字列: '{$string3_3}' -> " . (checkStringFullMatch($pattern3, $string3_3, 'i') ? "マッチ" : "不一致") . PHP_EOL; // マッチ 72echo PHP_EOL; 73 74// 例4: 空文字列の扱い 75$pattern4 = "^$"; // 空文字列にマッチするパターン 76$string4_1 = ""; 77$string4_2 = " "; // スペースは空文字列ではない 78 79echo "パターン: '{$pattern4}'" . PHP_EOL; 80echo " 文字列: '{$string4_1}' (空) -> " . (checkStringFullMatch($pattern4, $string4_1) ? "マッチ" : "不一致") . PHP_EOL; // マッチ 81echo " 文字列: '{$string4_2}' (スペース) -> " . (checkStringFullMatch($pattern4, $string4_2) ? "マッチ" : "不一致") . PHP_EOL; // 不一致 82echo PHP_EOL; 83 84?>
mb_ereg_match関数は、指定された文字列が正規表現パターンに完全に一致するかどうかを判定するために使用されます。この関数は特に日本語などの多バイト文字を含む文字列の処理に優れており、PCRE (Perl Compatible Regular Expressions) 系の関数とは異なり、文字列全体がパターンに合致する場合のみtrueを返します。部分一致は考慮されません。
引数は3つあります。$patternには検索したい正規表現のルールを文字列で指定します。文字列全体の一致を厳密にチェックするためには、パターンの開始を示す^と終了を示す$を明示的に記述することが重要です。$stringには、正規表現との照合対象となる文字列を指定します。$optionsは省略可能で、例えば'i'を指定すると大文字小文字を区別せずにマッチングを行います。
関数が文字列全体でパターンに合致した場合はtrueを返し、そうでなければfalseを返します。mb_ereg_matchを含む多バイト文字列関数を利用する際には、事前にmb_internal_encoding()関数で内部エンコーディングを"UTF-8"などに設定することで、多バイト文字が正しく処理されることを保証し、期待通りの結果を得られます。
mb_ereg_match関数は、対象文字列全体が正規表現パターンに完全に一致するかどうかを判定します。これは、文字列中にパターンが含まれていればマッチする一般的な正規表現関数とは異なる重要な点ですのでご注意ください。日本語などの多バイト文字を扱う際は、事前にmb_internal_encoding("UTF-8");などで内部エンコーディングを設定することが非常に重要です。これにより、文字化けや意図しない結果を防ぎ、期待通りのマッチングを実現できます。また、第三引数に'i'（大文字小文字を区別しない）などのオプションを指定することで、より柔軟な条件でマッチングを行うことが可能です。これらの点を理解し、適切に設定することで、コードを安全かつ正しく利用できます。