【PHP8.x】mb_ereg関数の使い方

Copy
1<?php
2
3/**
4 * 文字列が指定した正規表現パターンに全体として一致するかどうかを判定します。
5 * この関数は mb_ereg_match() の使用例を示します。
6 *
7 * @param string $pattern 正規表現パターン (マルチバイト文字対応)
8 * @param string $targetString チェック対象の文字列
9 * @return void
10 */
11function checkFullStringMatch(string $pattern, string $targetString): void
12{
13    // マルチバイト文字の正規表現を正しく扱うために、内部エンコーディングをUTF-8に設定します。
14    // この設定は mb_ereg_match を含む mb_ereg_* 関数群に影響します。
15    mb_regex_encoding('UTF-8');
16
17    echo "--- チェック開始 ---" . PHP_EOL;
18    echo "対象文字列: '{$targetString}'" . PHP_EOL;
19    echo "パターン: '{$pattern}'" . PHP_EOL;
20
21    // mb_ereg_match() は、文字列全体がパターンにマッチする場合に true を返します。
22    // 部分的な一致ではなく、文字列の先頭から末尾までが完全にパターンと一致する必要があります。
23    if (mb_ereg_match($pattern, $targetString)) {
24        echo "結果: マッチしました。" . PHP_EOL;
25    } else {
26        echo "結果: マッチしませんでした。" . PHP_EOL;
27    }
28    echo PHP_EOL;
29}
30
31// --- サンプルコードの実行 ---
32
33// パターン「すべてひらがなである」を定義します。
34// ^ は文字列の先頭、[ぁ-ん]+ はひらがな1文字以上、 $ は文字列の末尾を意味します。
35$hiraganaPattern = '^[ぁ-ん]+$';
36
37// マッチする例
38checkFullStringMatch($hiraganaPattern, 'こんにちは');
39
40// マッチしない例 (カタカナが含まれているため)
41checkFullStringMatch($hiraganaPattern, 'こんにちはセカイ');
42
43
44// パターン「有効な郵便番号形式（ハイフンあり）である」を定義します。
45// \d{3} は数字3桁、- はハイフン、\d{4} は数字4桁を意味します。
46$zipCodePattern = '^\d{3}-\d{4}$';
47
48// マッチする例
49checkFullStringMatch($zipCodePattern, '100-0001');
50
51// マッチしない例 (ハイフンがないため)
52checkFullStringMatch($zipCodePattern, '1000001');
53
54// マッチしない例 (全角数字が含まれているため)
55checkFullStringMatch($zipCodePattern, '１００-０００１');
56
57?>

PHPの mb_ereg_match 関数は、指定した文字列が正規表現パターンに「全体として」一致するかどうかを判定するために使用します。文字列の一部分が一致するだけでは不十分で、文字列の先頭から末尾までが完全にパターンと合致する必要があります。

この関数の第1引数には正規表現パターンを、第2引数には検査対象の文字列を指定します。戻り値は、文字列全体がパターンに一致した場合には true を、一致しなかった場合は false を返します。日本語のようなマルチバイト文字を正しく扱うために、事前に mb_regex_encoding() 関数で文字エンコーディング（例: 'UTF-8'）を設定することが重要です。

サンプルコードでは、この関数を使って2種類の検証を行っています。1つ目は、文字列が「すべてひらがな」であるかの判定です。'こんにちは' はパターンに完全一致するため true となりますが、カタカナを含む 'こんにちはセカイ' は一致しません。2つ目は、「郵便番号の形式」に合致するかの判定です。'100-0001' は形式通りであるため一致しますが、ハイフンがなかったり全角数字が使われていたりすると一致しないことが示されています。このように、特定のフォーマットを厳密にチェックする際に役立ちます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * テキスト内の特定の単語を検索し、HTMLの<strong>タグで強調（置換）します。
7 *
8 * このサンプルは、マルチバイト文字列に対応した正規表現置換関数 `mb_ereg_replace` を使用します。
9 * 大文字・小文字を区別せずにキーワードを検索し、マッチした部分を置換します。
10 *
11 * @param string $text 対象のテキスト。
12 * @param string $keyword 強調表示したいキーワード。
13 * @return string キーワードが強調表示されたテキスト。
14 */
15function highlightWords(string $text, string $keyword): string
16{
17    // 検索パターンとしてキーワードをそのまま使用します。
18    $pattern = $keyword;
19
20    // 置換後の文字列を定義します。
21    // '\\0' は正規表現にマッチした文字列全体を指す「後方参照」です。
22    // これにより、'PHP'や'php'など、マッチした元の表記を維持したままタグで囲むことができます。
23    $replacement = '<strong>\\0</strong>';
24
25    // 検索オプションを指定します。'i'は大文字と小文字を区別しないことを意味します。
26    $options = 'i';
27
28    // mb_ereg_replace を使用して、テキスト内のキーワードを置換します。
29    // エラーが発生した場合、falseまたはnullが返ることがあるため、
30    // 確実に文字列を返すようにキャストします。
31    $result = mb_ereg_replace($pattern, $replacement, $text, $options);
32
33    return (string)$result;
34}
35
36// --- 実行例 ---
37
38// 置換対象の日本語テキスト
39$originalText = 'PHPはWeb開発で人気のある言語です。多くのエンジニアがphpを学んでいます。';
40
41// 強調したいキーワード
42$targetKeyword = 'PHP';
43
44// 関数を呼び出してキーワードを強調
45$highlightedText = highlightWords($originalText, $targetKeyword);
46
47// 結果をHTMLとして出力
48header('Content-Type: text/html; charset=utf-8');
49echo '<p>' . htmlspecialchars($originalText, ENT_QUOTES, 'UTF-8') . '</p>';
50echo '<p>↓</p>';
51// 下の行では、<strong>タグがHTMLとして解釈されるようにhtmlspecialcharsは使用しません。
52echo '<p>' . $highlightedText . '</p>';
53
54// --- 期待されるブラウザでの表示 ---
55//
56// PHPはWeb開発で人気のある言語です。多くのエンジニアがphpを学んでいます。
57//
58// ↓
59//
60// <strong>PHP</strong>はWeb開発で人気のある言語です。多くのエンジニアが<strong>php</strong>を学んでいます。
61

このサンプルコードは、マルチバイト文字（日本語など）に対応した正規表現置換を行うmb_ereg_replace関数の使用例です。指定したテキストの中から、特定のキーワードを検索し、HTMLの<strong>タグで囲んで強調表示（太字に）する処理を実装しています。

この関数は主に4つの引数を取ります。第1引数$patternには検索する文字列のパターンを正規表現で指定します。第2引数$replacementには、パターンに一致した部分を置き換えるための文字列を指定します。ここで使われている\\0は「一致した文字列全体」を指す特殊な記法（後方参照）で、これにより'PHP'や'php'といった元の表記を維持したままタグ付けが可能です。第3引数$textは、処理対象となる元の文字列です。第4引数$optionsでは検索の挙動を制御でき、サンプルでは'i'を指定することで大文字・小文字を区別しない検索を実現しています。

関数の戻り値は、置換処理が行われた後の文字列です。ただし、エラーが発生した場合などにはfalseやnullが返る可能性があるため、サンプルでは(string)キャストを行い、常に文字列として結果を扱えるようにしています。