phpのHTMLをエスケープ処理する関数

Question

php にて、HTMLをエスケープ処理する関数として下記のようなものがありました。

function h($var) {
	if ( is_array($var) ) {
		return array_map( 'h', $var );
	} else {
		return htmlspecialchars( $var, ENT_QUOTES, 'UTF-8' );
	}
}

毎度、「htmlspecialchars( $var, ENT_QUOTES, 'UTF-8' )」を記述することが短縮できるということは理解できるのですが、その前の部分の

	if ( is_array($var) ) {
		return array_map( 'h', $var );
	}

は何をしているのでしょうか。$varが配列だった場合には、、、？？？よくわかりませんので教えていただけますと幸いです。

よろしくお願いいたします。

Answer 1

これはPHPのマニュアルを覗いたらわかる内容ではありますが、
is_array
array_map

結論から言うと、配列で渡されたものをすべてh関数を適用して戻す。

---

is_arrayで渡された変数が配列かどうか確認し、次のarray_mapに渡されています。
array_mapの仕様を確認すると、コールバック関数を"h"としています。
つまり、この質問のh関数自身ですね。

それにarray_mapの第2引数で$varの配列情報（is_arrayで配列と判断されたため）を渡しています。
これによりarray_map内部では、配列の要素は１つ１つ分解され、h関数を呼ぶようになっているわけです。

h関数を配列ではない変数を引数として呼び出されたものは、配列ではないので2つ目の処理htmlspecialchars側に処理が変わります。

したがって、配列だろうと、ただの変数だろうといずれにしてもhtmlspecialcharsを呼ぶようにする
という仕様のようですね。ちょっとは便利か。

追記 一応確認用のコードです:

<?php

function h( $var ) {
	if ( is_array( $var ) ) {
		return array_map( 'h', $var );
	} else {
		return htmlspecialchars( $var , ENT_QUOTES,  'utf-8' );
	}
}

// --- 必要データ準備
$arrayvar = array(
	"1" => "<h>配列</h>",
	"2" => "<input type='text' value='配列2'>配列2",
	"3" => "<script language='javascript'>alert('test');</script>",
	"4" => ""
);

$avar = "<b>test</b>";
// -----------------------------------------------------

// --- 確認
echo "配列:" . "\n";
var_dump( h( $arrayvar ) );

echo "変数:" . "\n";
var_dump( h( $avar ) );

echo "ただの値:" . "\n";
var_dump(h ( "<h1>test</h1>" ) );

Answer 2

はい、array_map()関数を使っていますね。
$varが配列だった場合、配列内の要素を１つずつ取り出して、function h ()を実行させてから$var配列に戻して、全部終わったらそれをreturnする。
こういったことをやっています。

array_map関数は、第２引数で指定された配列の全要素に対して、第１引数に指定された関数を１個ずつ実行させるという機能があります。「コールバック関数」と、公式ドキュメントでは呼んでいますね。
http://php.net/manual/ja/function.array-map.php

return array_map( 'h', $var );

第一引数に指定する関数ですが、'h'と、一見ただの文字データに見えますが、これは関数名を表しています。

今回の場合だと、function h 関数ですね。
$varが配列だった場合、要素を１個取り出してそれを引数にしてh関数を実行させます。
そうすると、取り出した値が文字列だったら、そのままhtmlspecialcharasが実行されて値が返ってきますね。
仮に、取り出した要素がさらに配列だった場合でも、array_map()によってさらにその要素が取得されて・・・といった感じでどんどんループしていきます。

こうすることによって、f()関数はたとえ引数に文字列ではなく配列を渡した場合でも、その全ての値をHTMLエスケープすることが可能になっているということです。

配列の要素１つ１つを、foreachなどで展開させてからエスケープするのは手間ですから、大分省略できますね。

Comments

[singlestroke]

ループしているということが分かりました。ありがとうございます。

Answer 3

再帰という技法です
自分自身を呼び再度処理して貰うことです