【PHP】文字の置き換え、str_replace()と正規表現置換preg_replace()

PHPで文字列置換するならstr_replace()と正規表現を用いたpreg_replace()。簡単解説。

WordpressやPHPのレッスンをしている際に文字の置き換えに関する質問を頂いたので、自分も少し調べつつメモ書き。

文字列の置換えの関数についての記事となっています。

特に正規表現を使った関数は非常に便利ですが、正規表現について私はうろ覚えでいつも調べながら使っているので備忘録として記しておこうと思います。

PHPでシンプルな文字の置き換えをするならstr_replace()

公式のPHPのドキュメントでは以下のように掲載されています。

PHP: str_replace - Manual

(PHP 4, PHP 5, PHP 7)

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

str_replaceは日本語による検索、置換えにも対応しています。

▼使い方は以下のような形。

str_replace('検索する文字列', '置き換え後の文字列', '対象の文字列');

第１引数に検索する文字列。

第２引数に置き換え後の文字列。

第３引数に検索置き換えの対象の文字列。

第４引数は省略可で、変数指定した場合は何箇所置き換えたかをカウントして代入します。

▼例1

<?php
echo str_replace('am', 'am not', 'I am John');
/*実行結果
I am not John
*/
?>

1,2,3の引数は文字列ではなくその文字列が入った配列も可。

配列の場合はそれぞれ置き換えを実行していきます。

▼例2 配列を指定した場合

<?php
$search  = array('I', 'am', 'John');
$replace = array('You', 'are', 'Ken');
echo str_replace($search, $replace, 'I am John.');
/*実行結果
You are Ken.
*/
?>

正規表現による文字の置き換えをするならpreg_replace()

PHPで正規表現を使った文字置き換え、preg_replaceの使い方はstr_replaceとほとんど同じです。

PHP: preg_replace - Manual

(PHP 4, PHP 5, PHP 7)

preg_replace — 正規表現検索および置換を行う

preg_replace('検索する文字列のパターン', '置き換え後の文字列', '対象の文字列');

正規表現とは

正規表現とは、文字列をパターンで検索する方法のこと。

特殊な書き方をするので、完全に使いこなすにはそれ専門の知識と経験が必要なものです。

ただ通常では難しい条件を指定した強力な文字検索が可能なので、調べながらでも使えるようになると非常に便利です。

例えばHTMLから特定のタグを検索しclass/idを追加したり、改行やスペースなど特殊な記号を置き換えたり、、文字検索・置換において、「できたらいいな」を実現するのが正規表現と言っても過言ではないと思います。

画像にクラスを追加し、aタグで囲った例

echo preg_replace('/<img src="(.*?)" class="(.*?)">/', '<a href="$1" target="_blank"><img src="$1" class="$2 new-class"></a>', '<img src="images/sample.jpg" class="default-class">' );
/*▼出力結果
<a href="images/sample.jpg" target="_blank"><img src="images/sample.jpg" class="default-class new-class"></a>
*/