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

作成日: 更新日:

mb_ereg関数は、マルチバイト文字列を対象として正規表現によるパターンマッチングを実行する関数です。この関数は、第1引数で指定された正規表現パターンが、第2引数の検索対象文字列内に存在するかどうかを検査します。パターンがマッチした場合は true を、マッチしなかった場合は false を返します。オプションとして第3引数に配列変数を渡すことで、マッチした部分文字列を取得できます。この場合、配列の最初の要素にはパターン全体にマッチした文字列が、2番目以降の要素にはパターン内の丸括弧でキャプチャされた部分文字列が順番に格納されます。この関数の正規表現の評価は、mb_regex_encoding関数などで設定された内部文字エンコーディングに基づいて行われるため、日本語のようなマルチバイト文字を1文字として正しく扱うことが可能です。この検索では大文字と小文字が区別されます。大文字と小文字を区別しない検索を行いたい場合は、代わりにmb_eregi関数を使用してください。

基本的な使い方

構文(syntax)

<?php
$pattern = "[0-9]+";
$string = "今日の気温は25度です。";
$matches = [];

mb_ereg($pattern, $string, $matches);
?>

引数(parameters)

string $pattern, string $string, ?array &$matches = null

  • string $pattern: マッチングに使用する正規表現パターンを指定する文字列
  • string $string: パターンにマッチングさせる対象の文字列
  • ?array &$matches = null: マッチした部分文字列を格納する配列。省略可能で、省略した場合はマッチ結果は返されません。

戻り値(return)

int|bool

正規表現にマッチした場合、マッチした文字列の数(0以上の整数)を返します。マッチしなかった場合は false を返します。

サンプルコード

PHP mb_ereg_matchで文字列全体の一致を判定する

<?php

/**
 * 文字列が指定した正規表現パターンに全体として一致するかどうかを判定します。
 * この関数は mb_ereg_match() の使用例を示します。
 *
 * @param string $pattern 正規表現パターン (マルチバイト文字対応)
 * @param string $targetString チェック対象の文字列
 * @return void
 */
function checkFullStringMatch(string $pattern, string $targetString): void
{
    // マルチバイト文字の正規表現を正しく扱うために、内部エンコーディングをUTF-8に設定します。
    // この設定は mb_ereg_match を含む mb_ereg_* 関数群に影響します。
    mb_regex_encoding('UTF-8');

    echo "--- チェック開始 ---" . PHP_EOL;
    echo "対象文字列: '{$targetString}'" . PHP_EOL;
    echo "パターン: '{$pattern}'" . PHP_EOL;

    // mb_ereg_match() は、文字列全体がパターンにマッチする場合に true を返します。
    // 部分的な一致ではなく、文字列の先頭から末尾までが完全にパターンと一致する必要があります。
    if (mb_ereg_match($pattern, $targetString)) {
        echo "結果: マッチしました。" . PHP_EOL;
    } else {
        echo "結果: マッチしませんでした。" . PHP_EOL;
    }
    echo PHP_EOL;
}

// --- サンプルコードの実行 ---

// パターン「すべてひらがなである」を定義します。
// ^ は文字列の先頭、[ぁ-ん]+ はひらがな1文字以上、 $ は文字列の末尾を意味します。
$hiraganaPattern = '^[ぁ-ん]+$';

// マッチする例
checkFullStringMatch($hiraganaPattern, 'こんにちは');

// マッチしない例 (カタカナが含まれているため)
checkFullStringMatch($hiraganaPattern, 'こんにちはセカイ');


// パターン「有効な郵便番号形式(ハイフンあり)である」を定義します。
// \d{3} は数字3桁、- はハイフン、\d{4} は数字4桁を意味します。
$zipCodePattern = '^\d{3}-\d{4}$';

// マッチする例
checkFullStringMatch($zipCodePattern, '100-0001');

// マッチしない例 (ハイフンがないため)
checkFullStringMatch($zipCodePattern, '1000001');

// マッチしない例 (全角数字が含まれているため)
checkFullStringMatch($zipCodePattern, '100-0001');

?>

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

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

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

この関数を使用する際は、事前にmb_regex_encoding()で文字エンコーディングを正しく設定することが重要です。この設定を忘れると、特に日本語などのマルチバイト文字を扱う際に意図通りに動作しない原因となります。mb_ereg_match()は文字列の先頭から末尾までが完全にパターンと一致するかを判定する関数です。文字列の一部が一致するかを調べるmb_ereg()とは役割が異なるため、目的に応じて使い分けてください。また、正規表現パターン内の\dは半角数字にのみマッチします。全角数字も対象に含めたい場合は、パターンを[0-90-9]のように記述する必要があります。

PHP mb_eregで単語を強調する

<?php

declare(strict_types=1);

/**
 * テキスト内の特定の単語を検索し、HTMLの<strong>タグで強調(置換)します。
 *
 * このサンプルは、マルチバイト文字列に対応した正規表現置換関数 `mb_ereg_replace` を使用します。
 * 大文字・小文字を区別せずにキーワードを検索し、マッチした部分を置換します。
 *
 * @param string $text 対象のテキスト。
 * @param string $keyword 強調表示したいキーワード。
 * @return string キーワードが強調表示されたテキスト。
 */
function highlightWords(string $text, string $keyword): string
{
    // 検索パターンとしてキーワードをそのまま使用します。
    $pattern = $keyword;

    // 置換後の文字列を定義します。
    // '\\0' は正規表現にマッチした文字列全体を指す「後方参照」です。
    // これにより、'PHP'や'php'など、マッチした元の表記を維持したままタグで囲むことができます。
    $replacement = '<strong>\\0</strong>';

    // 検索オプションを指定します。'i'は大文字と小文字を区別しないことを意味します。
    $options = 'i';

    // mb_ereg_replace を使用して、テキスト内のキーワードを置換します。
    // エラーが発生した場合、falseまたはnullが返ることがあるため、
    // 確実に文字列を返すようにキャストします。
    $result = mb_ereg_replace($pattern, $replacement, $text, $options);

    return (string)$result;
}

// --- 実行例 ---

// 置換対象の日本語テキスト
$originalText = 'PHPはWeb開発で人気のある言語です。多くのエンジニアがphpを学んでいます。';

// 強調したいキーワード
$targetKeyword = 'PHP';

// 関数を呼び出してキーワードを強調
$highlightedText = highlightWords($originalText, $targetKeyword);

// 結果をHTMLとして出力
header('Content-Type: text/html; charset=utf-8');
echo '<p>' . htmlspecialchars($originalText, ENT_QUOTES, 'UTF-8') . '</p>';
echo '<p>↓</p>';
// 下の行では、<strong>タグがHTMLとして解釈されるようにhtmlspecialcharsは使用しません。
echo '<p>' . $highlightedText . '</p>';

// --- 期待されるブラウザでの表示 ---
//
// PHPはWeb開発で人気のある言語です。多くのエンジニアがphpを学んでいます。
//
// ↓
//
// <strong>PHP</strong>はWeb開発で人気のある言語です。多くのエンジニアが<strong>php</strong>を学んでいます。

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

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

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

mb_ereg_replace関数はマルチバイト文字の置換に便利ですが、いくつか注意点があります。まず、検索パターンに正規表現で特別な意味を持つ記号(例: .*)が含まれると、意図しないマッチングが起こるため注意が必要です。置換文字列内の\\0は、マッチした文字列全体を指す後方参照という機能です。これを正しく扱うには、サンプルコードのようにシングルクォートで囲むのが確実です。また、この関数を正しく動作させるには、mb_internal_encoding()であらかじめ文字エンコーディングを'UTF-8'などに指定しておくことが推奨されます。関数の戻り値はエラー時に文字列以外になる可能性があるため、(string)でキャストするとより安全なコードになります。最後に、このサンプルはHTMLタグを生成するため、ユーザーからの入力をキーワードにする際は、htmlspecialcharsで無害化するなどのセキュリティ対策が必須です。

【PHP8.x】mb_ereg関数の使い方 | いっしー@Webエンジニア