【PHP8.x】str_ireplace関数の使い方
str_ireplace関数は、文字列の中から特定の文字列を大文字小文字を区別せずに検索し、別の文字列に置換して返す関数です。
この関数は、与えられた文字列データに対して、指定した検索文字列と完全に一致するかどうかを判定する際に、アルファベットの大文字と小文字の違いを無視して処理を進める点が最大の特徴です。例えば、「PHP」と「php」を同じものとして扱いたい場合に非常に役立ちます。
第一引数には検索対象となる文字列、または複数の文字列をまとめた配列を指定します。第二引数には置換後の文字列、または置換後の複数の文字列をまとめた配列を指定してください。検索対象と置換後の文字列がそれぞれ配列で与えられた場合、配列の順序に従って1対1で置換処理が行われます。もし第二引数が単一の文字列で、第一引数が配列であった場合は、配列内のすべての検索文字列がその単一の文字列に置換されます。
第三引数には実際に置換が行われる対象の文字列、または文字列の配列を指定します。また、オプションとして第四引数に整数型の変数を渡すことで、実際に置換が行われた回数をその変数に格納することができます。
戻り値としては、すべての置換処理が完了した後の新しい文字列が返されます。もし第三引数に文字列の配列が与えられた場合は、処理後の文字列を要素に持つ配列が返されます。例えば、ユーザーが入力したテキストから特定の単語をすべて削除したり、表記ゆれを統一したりする際に非常に便利です。文字列操作において、大文字小文字の違いを気にせずに一括置換を行いたい場合に活用されます。
基本的な使い方
構文(syntax)
<?php
$search = 'world'; // 検索する文字列 (大文字小文字を区別しない)
$replace = 'PHP'; // 置換する文字列
$subject = 'Hello World! This is a world of programming.'; // 対象の文字列
$result = str_ireplace($search, $replace, $subject);
echo $result;
?>
引数(parameters)
array|string $search, array|string $replace, array|string $subject, int &$count = null
- array|string $search: 置換対象の文字列または文字列の配列を指定します。
- array|string $replace: 置換後の文字列または文字列の配列を指定します。
- array|string $subject: 検索および置換を行う対象の文字列または文字列の配列を指定します。
- int &$count = null: 置換が行われた回数を格納する変数を指定します。省略可能です。
戻り値(return)
array|string|false
引数 $search
、$replace
、$subject
の内容を大文字小文字を区別せずに置換した結果が返されます。置換が行われなかった場合は元の $subject
が返され、エラーが発生した場合は false
が返されます。