(PHP 4, PHP 5, PHP 7, PHP 8)

str_replace — 検索文字列に一致したすべての文字列を置換する

この関数は、subject の中の search を全て replace に置換します。

固定の文字列ではなく、パターンベースでテキストを置換したい場合、 preg_replace() を使ってください。

search と replace が配列の場合、str_replace() は各配列から値をひとつ取り出し、 subject 上で検索と置換を行うために使用します。 replace の値が search よりも少ない場合、 置換される値の残りの部分には空の文字列が使用されます。 search が配列で replace が文字列の場合、この置換文字列が search の各値について使用されます。しかし、 逆は意味がありません。

search あるいは replace が配列の場合は、配列の最初の要素から順に処理されます。

探したい値。needle (針) と呼ばれることもあります。 配列を使えば、複数の値を指定することもできます。

見つかった search を置き換える値。 配列を使えば、複数の値を指定することもできます。

検索・置換の対象となる文字列あるいは配列。 haystack (干し草の山) と呼ばれることもあります。

subject が配列の場合、 subject の各エントリについて検索と置換が行われ、 戻り値は同様に配列となります。

指定した場合は、マッチして置換が行われた箇所の個数がここに格納されます。

この関数は、置換後の文字列あるいは配列を返します。

例1 基本的な str_replace() の例