PHPのsubstr_replace()関数とは？構文・パラメータ・使用例をわかりやすく解説

PHPのsubstr_replace()関数は、文字列の一部を別の文字列に置き換えるために使用される組み込み関数です。文字列の指定した位置から始まる部分を、任意の文字列に差し替えることができます。

構文

substr_replace(str, replacement, begin, len)

パラメータ

• str − 検査対象となる元の文字列を指定します。

• replacement − 挿入（置き換え）する文字列を指定します。

• begin − 置き換えを開始する位置を指定します。

  • 正の数の場合：文字列の先頭から数えて指定した位置から置き換えを開始します。

  • 負の数の場合：文字列の末尾から数えて指定した位置から置き換えを開始します。

  • 0の場合：文字列の先頭の文字から置き換えを開始します。

• len − 置き換える文字数を指定します。省略した場合は、文字列の末尾までが対象となります。

  • 正の数の場合：置き換える文字列の長さを表します。

  • 負の数の場合：置き換え後に文字列の末尾へ残す文字数を表します。

  • 0の場合：置き換えではなく、指定位置への文字列の挿入として動作します。

戻り値

substr_replace()関数は、置き換えが完了した文字列を返します。

使用例

以下は、文字列の一部を別の文字列に置き換える基本的な例です。

<?php
   echo substr_replace("Demo text","word",5);
?>

出力

実行結果は以下のとおりです。

Demo word

この例では、beginに「5」を指定しているため、文字列の先頭から5文字目以降（「text」の部分）が「word」に置き換えられています。

使用例：文字列の末尾から置き換える

次に、beginに負の数を指定して、文字列の末尾から数えた位置を基準に置き換えを行う例を見てみましょう。

<?php
   echo substr_replace("Demo text","word",-5);
?>

出力

実行結果は以下のとおりです。

Demoword

beginに「-5」を指定すると、文字列の末尾から5文字目の位置から置き換えが開始されるため、元の文字列の後半部分が「word」に置き換えられています。