PHPの「str_replace」関数は、
文字列の中にある文字を検索して、置き換えることができる。
置き換える文字を、空欄にすると、指定した文字・文字列を削除することも可能。
指定した文字が、文字列の中にあれば、検索・置換えの対象になる。

便利な機能の関数なので、使用頻度は高い。

文字列の前後の文字を削除するのに使える
「trim」「ltrim」「rtirm」関数とともに、
文字の削除に使われる関数の一つ。

「str_replace」関数の基本書式

str_replace(
array|string $search,
array|string $replace,
string|array $subject,
int &$count = null
): string|array

str_replace( ”検索する文字列”, ”置き換える文字列”, ”既存の文字列”, 置換えた回数を変数に格納): 返り値（文字列・配列）

$変数名 = str_replace('検索したい文字列', '置き換える文字列', '検索対象文字列', $空の変数);
$変数名 = str_replace('検索したい文字列', '置き換える文字列', '検索対象文字列', 置換えた回数を変数に格納);
$変数名 = str_replace('検索したい文字列', '置き換える文字列', '検索対象文字列');
$変数名 = str_replace('検索したい文字列', '置き換える文字列', $変数名);
$変数名 = str_replace($変数名, $変数名, $変数名);
$変数名 = str_replace($配列名, $配列名, $変数名);

引数として指定する「検索したい文字列」「置き換える文字列」「検索対象文字列」は、
「文字」「文字列」を直接記述することも可能だが、
「変数」に「文字」「文字列」を格納して指定することも可能。
「数字」「記号」なども指定することができる。

第四引数は、指定しなくても問題ないが、
空の変数名を指定すると、
その変数に、置換えた回数の数字を格納してくれる。
指定する引数は、第三引数までは必須。

「str_replace」関数のパラメータ

「search」と「replace」が「配列」の場合、
「str_replace()」関数は、各配列から値をひとつ取り出し、
「subject」で指定した「文字列」で、「検索」「置換」を行う。

「replace」の「配列」が、「search」の「配列」より少ない場合、
足りない「replace」の分は、「空」の文字列が適用され、文字が削除された状態になる。

「search」「replace」が配列の場合、配列の最初の要素から順に適用される。

パラメータ	説明
search	探したい値。needle (針) と呼ばれることもあります。配列を使えば、複数の値を指定することもできます。
replace	見つかった search を置き換える値。配列を使えば、複数の値を指定することもできます。
subject	検索・置換の対象となる文字列あるいは配列。 haystack (干し草の山) と呼ばれることもあります。 subject が配列の場合、 subject の各エントリについて検索と置換が行われ、戻り値は同様に配列となります。
count	指定した場合は、マッチして置換が行われた箇所の個数がここに格納されます。
戻り値	この関数は、置換後の文字列あるいは配列を返します。

「str_replace」関数のサンプルコード

<?php
$str = 'abcde';
$str = str_replace('ab', '', $str);
echo $str;
?>

//出力結果：cde

Back

文字列を削除する「str_replace」関数の書式

「str_replace」関数は、文字を置き換える事ができる関数ですが、置き換える文字を「””（空・無指定）」にする事で、検索した文字を「削除」する事ができる。

文字列を削除する「str_replace」関数のサンプルコード

$変数名 = str_replace(”検索する文字列”, "", ”既存の文字列”);

$変数名 = str_replace($変数名, "", $変数名);
$変数名 = str_replace($配列名, "", $変数名);

//「文字」を削除するコード
$変数名 = str_replace(”文字”, "", ”既存の文字列”);
//「改行」を削除するコード
$変数名 = str_replace(”¥n”, "", ”既存の文字列”);
$SampleText = str_replace("\r\n", '', $SampleText);
$SampleText = str_replace(array("\r\n", "\r", "\n"), '', $SampleText);
$SampleText = str_replace(array("\r", "\n"), '', $SampleText);
//「スペース」を削除するコード
$変数名 = str_replace(” ”, "", ”既存の文字列”);

<?php
$str = 'abcde';
$str = str_replace('ab', '', $str);
echo $str;
?>

//出力結果：cde

「str_replace」関数の基本書式

Back