PHPのstr_replace関数について解説

PHP の関数 str_replace は、文字列中の特定の部分を置き換えるために使います。

簡潔で直感的な構文により、文字列操作が手軽に行えます。

基本的な使い方を押さえることで、実用的なコーディングが可能になります。

基本的な使い方

str_replaceの基本構文

検索文字列、置換文字列、対象文字列の役割

PHPのstr_replace関数は、指定した文字列を検索して、指定した文字列と置換する処理を行います。

この関数は以下の3つの主要なパラメーターを用います。

• search

置換対象となる文字列や文字の集合です。

たとえば、"World"という文字列を探す場合に指定します。

• replace

置換後の文字列です。

上記の例では、"PHP"などと指定することで、検索された文字列がこの内容に変更されます。

• subject

検索や置換を行う元の文字列です。

サンプルコードでは、簡単な文言(例："Hello, World!")内での置換動作を確認できます。

以下のサンプルコードは、基本的な使い方を示しています。

<?php
// 対象文字列内の "World" を "PHP" に置換する例
$subject = "Hello, World!";
$search  = "World";
$replace = "PHP";
$result  = str_replace($search, $replace, $subject);
echo $result; // 結果として "Hello, PHP!" を出力
?>

Hello, PHP!

各パラメーターの詳細説明

str_replace関数は、第三引数に渡された文字列または配列内の全ての要素に対して動作します。

また、第4引数に変換した回数を返す変数を指定することも可能です。

各パラメーターについて注意するポイントは以下の通りです。

• 検索文字列(search)は、単一の文字列だけでなく配列でも指定でき、順番に対応する置換文字列と置換される。
• 対象文字列(subject)も単一文字列だけでなく、配列として渡すことで、複数の文字列に対して一斉に処理が実行される。

各パラメーターの使い方を把握することで、より柔軟な文字列操作が可能になります。

配列を用いた一括変換

配列を引数に指定する方法

str_replaceは、検索文字列と置換文字列として配列を指定することができます。

この方法は、一度に複数の文字列を検索して置換する際に有効です。

例えば、HTMLテンプレート内の特定のタグを別のタグに変換する際に利用できます。

配列内での順序と処理の流れ

配列として指定する際は、検索配列と置換配列の要素の順序が対応しています。

PHPは、各配列の要素ごとに以下のような処理を行います。

1. 検索配列の最初の要素にマッチする部分を探す
2. 対応する置換配列の最初の要素で置換する
3. 次の要素に対しても同様の処理を行う

順序が異なると意図しない結果となる場合があるため、要素順序には注意が必要です。

以下のサンプルコードは、複数の文字列を一括で置換する例です。

<?php
// 複数のキーワードを一括置換するサンプル
$subject = "Hello, World! Welcome to the World of PHP.";
$search  = ["World", "PHP"];
$replace = ["Universe", "PHP Programming"];
$result  = str_replace($search, $replace, $subject);
echo $result; // 出力例: "Hello, Universe! Welcome to the Universe of PHP Programming."
?>

Hello, Universe! Welcome to the Universe of PHP Programming.

複数置換の同時実行例

複数の文字列を同時に置換する場合、str_replaceは内部で順次処理を実行します。

この方法は、シンプルな一括置換処理のケースで効果を発揮します。

以下の例では、複数のキーワードを同時に置換するコードを提示します。

<?php
// 一括置換の実行例
$subject = "Red, Green, Blue are primary colors.";
$search  = ["Red", "Green", "Blue"];
$replace = ["Crimson", "Lime", "Azure"];
$result  = str_replace($search, $replace, $subject);
echo $result; // 出力例: "Crimson, Lime, Azure are primary colors."
?>

Crimson, Lime, Azure are primary colors.

実践的な応用例

フォームデータのサニタイズでの活用

フォームから送信されたデータには、ユーザー入力により不正な文字列が含まれる可能性があります。

str_replaceを利用することで、特定の文字列やタグを除去または置換し、データの安全性を高めることが可能です。

例えば、スクリプトタグを無害化する場合などに利用できます。

以下のコード例は、フォームデータ内の不正なHTMLタグを置換する場合のサンプルです。

<?php
// フォーム入力されたデータ内の <script> タグを無害化する例
$inputData     = "<p>Hello</p><script>alert('XSS');</script>";
$searchTags    = ["<script>", "</script>"];
$replaceTags   = ["<script>", "</script>"];
$sanitizedData = str_replace($searchTags, $replaceTags, $inputData);
echo $sanitizedData; // 出力例: "<p>Hello</p><script>alert('XSS');</script>"
?>

<p>Hello</p><script>alert('XSS');</script>

HTMLタグ変換での利用シーン

具体的なコード例のポイント

HTMLを扱う際、特定のタグを別のタグやテキストに置換する必要が生じる場合があります。

たとえば、古いHTMLタグをHTML5の仕様に合わせて変更するケースなどです。

以下は、簡単なHTMLコード内の<b>タグをタグに変換するサンプルコードになります。

<?php
// HTML内の <b>タグを <strong>タグに置換する例
$htmlContent = "<p>This is a <b>bold</b> statement.</p>";
$search      = ["<b>", "</b>"];
$replace     = ["<strong>", "</strong>"];
$converted   = str_replace($search, $replace, $htmlContent);
echo $converted; // 出力例: "<p>This is a <strong>bold</strong> statement.</p>"
?>

<p>This is a <strong>bold</strong> statement.</p>