[PHP]str_replaceで複数置換する際に気をつけること

関数 str_replace() は、検索語句に配列を指定すると、複数の単語を一括で置換することができます。
しかし、この動作には少し癖があるので間違えると予期していない結果になることがあります。

仮に「AB」という文字と、「DC」という文字を全て「D」に置き換えたいときに、
次のようなコードを書いたとします。

<?php
$data = "ABC";
echo str_replace(array("AB", "DC"), "D", $data);
結果: D

期待される結果は「DC」となる予定でしたが、実際の結果は「D」だけになります。
まず「AB」が「D」に置き換えられ、文字列は「DC」になり、「DC」は「D」に置き換えられるので結局「D」だけが残ります。
要するに str_replace で複数の検索語句を指定した場合、最初から順番に置換を実行していくので、全て同時に置換するわけでは無いということです。
この動作は次のように書いた時と同じです。

<?php
$data = "ABC";
$data = str_replace("AB", "D", $data);
$data = str_replace("DC", "D", $data);
echo $data;
結果: D

元々の文字列には「DC」という単語はないにもかかわらず、最初の置換が実行された結果「DC」という単語ができてしまい、欲しい結果が得られません。
それを回避するには preg_replace を使うのが簡単です。

<?php
$data = "ABC";
echo preg_replace("/AB|DC/", "D", $data);
結果: DC

[PHP]文章中の単語に自動でリンクを貼る(キーワードリンク)

よくコンピュータ系のサイトで専門用語に解説ページへのリンクが貼られているのを見かけますが、構造的には単語と URL を用意しておき、当てはまる単語にリンクを貼るというものです。

単純に組むとすでに置換した単語を二重に置換してしまうので、少し工夫が必要になります。

<?php
//元となる文章
$str = "ウェブブラウザとはウェブサイトを閲覧するためのソフトウェアです";
 
//単語とURLのリスト
$wordlist = array(
  "ウェブ" => "http://en.wikipedia.org/wiki/Web",
  "ウェブブラウザ" => "http://en.wikipedia.org/wiki/Web_browser",
  "ウェブサイト" => "http://en.wikipedia.org/wiki/Website",
  "ソフトウェア" => "http://en.wikipedia.org/wiki/Software"
);
 
//単語の文字数が長いものから順に並べ替える
uksort($wordlist, function($a, $b){
	return mb_strlen($b, 'utf-8') - mb_strlen($a, 'utf-8'); });

$pairs = array();

foreach($wordlist as $word => $url){
	$pairs[$word] = '<a href="' . $url . '">' . $word . '</a>';
}

$str = strtr($str, $pairs);
echo $str;

今回は「ウェブブラウザとはウェブサイトを閲覧するためのソフトウェアです」という文の用語にリンクをつけています。
単語は配列に $wordlist 登録し、キーが対象語句、値がリンク先です。

途中文字の長い順に単語を並び替えていますが、そうしておかないと「ウェブブラウザ」を置換するより先に「ウェブ」だけが置換され、「ブラウザ」の文字が取り残されてしまうからです。


(2014/05/07 加筆)

コメントで教えていただきましたが strtr は基本的にマルチバイト非対応の関数のため、文字コードによっては誤作動を起こす場合があるようです。
その場合は以下のマルチバイト対応版 mb_strtr() を使うことをおすすめします。

参考: 「マルチバイト未対応の関数をいろいろ対応させてみた」
http://qiita.com/mpyw/items/ceae0ed5285093c76087#2-7