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

<?php

/**
 * preg_replace_callback の基本的な使用方法を示す関数。
 * この関数は、入力文字列内のすべての数字を検索し、それらを2倍にした値で置換します。
 */
function demonstratePregReplaceCallback(): void
{
    // 置換対象の元の文字列
    $originalString = "商品Aの価格は1200円、商品Bの価格は500円です。合計は1700円です。";
    echo "元の文字列: " . $originalString . PHP_EOL;

    // 正規表現パターン: 1つ以上の数字にマッチします
    // 'g'フラグがないため、デフォルトで文字列全体で検索し、全てのマッチを処理します。
    $pattern = '/\d+/';

    // preg_replace_callback を使用して置換を実行します。
    // マッチした各数字に対してコールバック関数が実行されます。
    $replacedString = preg_replace_callback(
        $pattern,
        function (array $matches): string {
            // $matches はマッチした部分文字列の配列です。
            // $matches[0] はパターン全体にマッチした文字列です。
            $matchedNumber = (int) $matches[0]; // マッチした数字を整数に変換
            $doubledNumber = $matchedNumber * 2; // 数字を2倍にする

            return (string) $doubledNumber; // 2倍にした数字を文字列として返します
        },
        $originalString
    );

    // 置換後の文字列を出力します
    if ($replacedString !== null) {
        echo "置換後の文字列: " . $replacedString . PHP_EOL;
    } else {
        echo "置換中にエラーが発生しました。" . PHP_EOL;
    }
}

// 関数を実行します
demonstratePregReplaceCallback();

?>

preg_replace_callback関数は、文字列内で正規表現にマッチした部分を、コールバック関数の処理結果を用いて動的に置換するために使用されます。このサンプルコードでは、商品価格情報を含む元の文字列からすべての数字を見つけ出し、それらの数字を2倍にした値で置き換える具体的な方法を示しています。

コードの中では、まず元の文字列と「一つ以上の数字」にマッチする正規表現パターン/\d+/を定義しています。preg_replace_callback関数は、第一引数にこの正規表現パターン、第二引数にマッチした部分に対して実行されるコールバック関数（ここでは無名関数）、第三引数に置換対象の文字列を受け取ります。

コールバック関数は、正規表現にマッチした各部分ごとに呼び出されます。この関数には、マッチした部分文字列を格納した配列$matchesが引数として渡されます。$matches[0]にはパターン全体にマッチした文字列が含まれます。サンプルでは、この$matches[0]を整数に変換し、2倍にした後、最終的に文字列として返しています。このコールバック関数が返した文字列が、元の文字列のマッチした部分に置き換えられることで、動的な置換が実現されます。

preg_replace_callback関数は、置換が成功した場合は処理後の文字列を返します。もし置換処理中にエラーが発生した場合はnullを返すため、結果のチェックを行うことが推奨されます。この関数を使用することで、固定の文字列ではなく、マッチした内容に応じた柔軟な置換処理が可能になります。

<?php

/**
 * 指定された複数の正規表現パターンに基づいて、テキスト内の文字列を置換します。
 * システムエンジニアを目指す初心者が、preg_replace関数で複数の置換を一度に行う方法を理解するためのサンプルです。
 *
 * @param string $subject 置換処理を行う元の文字列。
 * @return string 置換が実行された後の新しい文字列。
 */
function performMultipleReplacements(string $subject): string
{
    // 置換する複数のパターンを配列で定義します。
    // ここでは、特定の果物の名前（大文字・小文字を区別しない）をターゲットにしています。
    $patterns = [
        '/\bapple\b/i',   // 'apple'という単語全体を大文字・小文字を区別せずにマッチ
        '/\borange\b/i',  // 'orange'という単語全体を大文字・小文字を区別せずにマッチ
        '/\bbanana\b/i'  // 'banana'という単語全体を大文字・小文字を区別せずにマッチ
    ];

    // 各パターンに対応する置換後の文字列を配列で定義します。
    // $patterns配列の最初の要素は$replacements配列の最初の要素で置換され、以下同様にペアで処理されます。
    $replacements = [
        'grape',  // 'apple'を'grape'に置換
        'mango',  // 'orange'を'mango'に置換
        'kiwi'    // 'banana'を'kiwi'に置換
    ];

    // preg_replace関数を使用して、複数のパターンと置換を一度に実行します。
    // $patternsと$replacementsに配列を渡すことで、複数の置換ルールが適用されます。
    // 第5引数の$countは、実際に置換が行われた回数を格納する変数です（オプション）。
    $replacedString = preg_replace($patterns, $replacements, $subject, -1, $count);

    echo "元の文字列: " . $subject . "\n";
    echo "置換後の文字列: " . $replacedString . "\n";
    echo "実行された置換回数: " . $count . "\n";

    return $replacedString;
}

// サンプルコードの実行
$originalText1 = "I have an Apple, an Orange, and a Banana. Apple pie is delicious.";
performMultipleReplacements($originalText1);

echo "\n"; // 出力の区切り

$originalText2 = "The fruit basket contains Apple, Orange, and Banana.";
performMultipleReplacements($originalText2);

?>

PHPのpreg_replace関数は、指定された正規表現パターンに基づいて文字列内のテキストを置換するための関数です。このサンプルコードは、複数の正規表現パターンと置換文字列を一度に適用して、テキストを一括で処理する方法を示しています。

performMultipleReplacements関数では、まず置換したい複数の正規表現パターンを$patternsという配列に定義します。ここでは、/\bapple\b/iのように、特定の単語（例：apple）を大文字・小文字を区別せずにマッチさせる正規表現が使われています。次に、これらのパターンに対応する置換後の文字列を$replacementsという配列に定義します。$patterns配列の最初の要素は$replacements配列の最初の要素で置換され、以下同様にペアで処理されます。

preg_replace関数を呼び出す際、最初の引数$patternに$patterns配列、二番目の引数$replacementに$replacements配列、三番目の引数$subjectに元の文字列を渡します。このように配列を渡すことで、複数の置換ルールが同時に適用されます。第四引数の$limitは置換回数の上限を指定し、-1は無制限を意味します。第五引数の$countはオプションで、実際に置換が行われた合計回数を格納するために使用されます。

この関数は、置換が実行された新しい文字列を返します。もし置換が全く行われなかったり、エラーが発生したりした場合は、nullが返されることがあります。この方法により、複雑なテキスト処理も簡潔に記述できます。