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

Copy
1<?php
2
3/**
4 * str_ireplace() 関数の使用法を示します。
5 * この関数は、大文字・小文字を区別しない文字列置換を実行します。
6 *
7 * キーワード "bypassing str_ireplace php function" について:
8 * str_ireplace() は、大文字・小文字の様々なバリエーションを個別に指定する手間を「バイパス（回避）」し、
9 * 単一の検索文字列で全てをカバーできるため、非常に効率的です。
10 * 特に、ユーザー入力のサニタイズや、特定のキーワードをケースを気にせずに置換したい場合に役立ちます。
11 */
12function demonstrateStrIreplaceFunctionality(): void
13{
14    // --- 例1: 基本的な大文字・小文字を区別しない置換 ---
15    $originalString1 = "Hello World! This is a test string. WORLD!";
16    $search1         = "world"; // "world" を大文字・小文字を区別せずに検索
17    $replace1        = "PHP";
18    $replacementsCount1 = 0; // 実際に置換された回数を格納する変数
19
20    $resultString1 = str_ireplace($search1, $replace1, $originalString1, $replacementsCount1);
21
22    echo "--- 例1: 基本的な置換 ---" . PHP_EOL;
23    echo "元の文字列: " . $originalString1 . PHP_EOL;
24    echo "検索: '" . $search1 . "', 置換: '" . $replace1 . "'" . PHP_EOL;
25    echo "結果:     " . $resultString1 . PHP_EOL;
26    echo "置換回数: " . $replacementsCount1 . PHP_EOL . PHP_EOL;
27
28    // --- 例2: 配列を使って複数の単語を置換 ---
29    $originalString2 = "このウェブサイトにはbadwordとanotherbadなコンテンツが含まれています。BADWORDとANOTHERBADを削除してください！";
30    $search2         = ['badword', 'anotherbad']; // これらの単語を大文字・小文字を区別せずに検索
31    $replace2        = ['[編集済み]', 'クリーン'];
32    $replacementsCount2 = 0;
33
34    $resultString2 = str_ireplace($search2, $replace2, $originalString2, $replacementsCount2);
35
36    echo "--- 例2: 複数の単語の置換 ---" . PHP_EOL;
37    echo "元の文字列: " . $originalString2 . PHP_EOL;
38    echo "検索: ['" . implode("', '", $search2) . "'], 置換: ['" . implode("', '", $replace2) . "']" . PHP_EOL;
39    echo "結果:     " . $resultString2 . PHP_EOL;
40    echo "置換回数: " . $replacementsCount2 . PHP_EOL . PHP_EOL;
41
42    // --- 例3: 複数の対象文字列（文字列の配列）内で置換 ---
43    $subjectArray3 = [
44        "First line with a badword.",
45        "Second line has ANOTHERBAD.",
46        "Third line has No bad words."
47    ];
48    $search3         = "badword";
49    $replace3        = "goodword";
50    $replacementsCount3 = 0;
51
52    $resultArray3 = str_ireplace($search3, $replace3, $subjectArray3, $replacementsCount3);
53
54    echo "--- 例3: 対象文字列の配列内での置換 ---" . PHP_EOL;
55    echo "元の対象文字列:" . PHP_EOL;
56    foreach ($subjectArray3 as $line) {
57        echo "- " . $line . PHP_EOL;
58    }
59    echo "検索: '" . $search3 . "', 置換: '" . $replace3 . "'" . PHP_EOL;
60    echo "結果の対象文字列:" . PHP_EOL;
61    foreach ($resultArray3 as $line) {
62        echo "- " . $line . PHP_EOL;
63    }
64    echo "置換回数: " . $replacementsCount3 . PHP_EOL . PHP_EOL;
65
66    // --- 例4: マッチする文字列が見つからない場合 ---
67    $originalString4 = "この文字列には特定の単語がありません。";
68    $search4         = "存在しない単語";
69    $replace4        = "見つかりました";
70    $replacementsCount4 = 0;
71
72    $resultString4 = str_ireplace($search4, $replace4, $originalString4, $replacementsCount4);
73
74    echo "--- 例4: マッチする文字列が見つからない場合 ---" . PHP_EOL;
75    echo "元の文字列: " . $originalString4 . PHP_EOL;
76    echo "検索: '" . $search4 . "', 置換: '" . $replace4 . "'" . PHP_EOL;
77    echo "結果:     " . $resultString4 . PHP_EOL;
78    echo "置換回数: " . $replacementsCount4 . PHP_EOL;
79}
80
81// 関数を呼び出して例を実行します
82demonstrateStrIreplaceFunctionality();
83
84?>

PHPのstr_ireplace関数は、文字列の中から特定のパターンを大文字・小文字を区別せずに検索し、別の文字列に置換する機能を提供します。これにより、「World」や「WORLD」といった単語も「world」という単一の検索条件で処理できるため、大文字・小文字の様々なパターンを個別に記述する手間を省き、効率的なコード作成に役立ちます。

この関数は、検索する文字列または配列を $search、置換後の文字列または配列を $replace、置換対象となる文字列または配列を $subject として受け取ります。例えば、単語のフィルタリングやユーザー入力の整形などで活用できます。オプションの $count 引数に変数を渡すことで、実際に置換が行われた回数を取得できます。関数は、置換が成功した場合は置換後の文字列または文字列の配列を返します。置換対象が見つからなかった場合でも、元の文字列や配列がそのまま返されるため、処理の継続性を保てます。

Copy
1<?php
2
3/**
4 * このスクリプトは、str_replace と str_ireplace の違いを比較し、
5 * 大文字・小文字を区別する置換と区別しない置換の動作を示します。
6 *
7 * str_replace: 大文字・小文字を区別して検索し置換します。
8 * str_ireplace: 大文字・小文字を区別せずに検索し置換します。
9 */
10
11// 元の文字列を定義
12$originalString = "Hello World, hello PHP, programming is fun!";
13
14// 検索する文字列 (大文字・小文字が混在する可能性を考慮)
15$searchString = "hello";
16
17// 置換する文字列
18$replaceString = "Hi";
19
20echo "元の文字列: " . $originalString . "\n\n";
21
22// --- str_replace の使用例 (大文字・小文字を区別) ---
23// 'hello' は 'Hello' と区別されるため、2番目の 'hello' のみが置換される
24$resultReplace = str_replace($searchString, $replaceString, $originalString);
25echo "str_replace の結果 (大文字・小文字を区別): \n";
26echo "  検索対象: '" . $searchString . "'\n";
27echo "  置換後:   '" . $resultReplace . "'\n\n";
28
29// --- str_ireplace の使用例 (大文字・小文字を区別しない) ---
30// 'hello' は 'Hello' と同じと見なされるため、両方が置換される
31$resultIReplace = str_ireplace($searchString, $replaceString, $originalString);
32echo "str_ireplace の結果 (大文字・小文字を区別しない): \n";
33echo "  検索対象: '" . $searchString . "'\n";
34echo "  置換後:   '" . $resultIReplace . "'\n\n";
35
36// str_ireplace の第4引数 $count の使用例
37$count = 0; // 置換回数を格納する変数を初期化
38$resultWithCount = str_ireplace($searchString, $replaceString, $originalString, $count);
39echo "str_ireplace の結果 (置換回数をカウント): \n";
40echo "  置換後:   '" . $resultWithCount . "'\n";
41echo "  置換回数: " . $count . " 回\n";
42
43?>

PHP 8のstr_ireplace関数は、文字列の中から特定の文字列を検索し、別の文字列に置換する機能を提供します。この関数は、大文字・小文字を区別せずに検索・置換を行う点が最大の特徴です。例えば、「hello」を検索対象とした場合、「Hello」や「HELLO」といった表記も同様に置換されます。これは、大文字・小文字を区別して動作するstr_replace関数との明確な違いです。

引数には、まず$searchに検索したい文字列（または文字列の配列）を、次に$replaceに置換後の文字列（または文字列の配列）を、そして$subjectに置換対象となる元の文字列（または文字列の配列）を指定します。さらに、オプションとして$countという整数型の変数を参照渡しで指定すると、実際に置換が行われた回数を取得できます。

この関数は、置換が成功した場合は置換後の文字列または配列を返します。検索対象の文字列や置換文字列が見つからない、または何らかの理由で処理に失敗した場合にはfalseを返します。サンプルコードでは、str_ireplaceが元の文字列中の「Hello」と「hello」の両方を「Hi」に置換し、同時に$count引数によってその置換回数を正確にカウントする動作を示しており、柔軟な文字列処理を実現します。