highlight_string

(PHP 4, PHP 5, PHP 7)

highlight_string — 文字列の構文ハイライト表示

説明

highlight_string ( string $str [, bool $return = FALSE ] ) : mixed

PHP 組込みの 構文ハイライタで定義されたカラーを使用して str を構文ハイライト表示したものを、html マークアップで出力あるいは返します。

パラメータ

str

ハイライト表示する PHP コード。開始タグを含む必要があります。

return

このパラメータを TRUE にすると、この関数はハイライトされたコードを返します。

返り値

return が TRUE の場合は、 ハイライトされたコードを文字列として返し、表示しません。 それ以外の場合は、成功した場合に TRUE、 失敗した場合に FALSE を返します。

例

例1 highlight_string() の例

<?php
highlight_string('<?php phpinfo(); ?>');
?>

上の例の出力は以下となります。

<code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php phpinfo</span><span style="color: #007700">(); </span><span style="color: #0000BB">?&gt;</span>
</span>
</code>

注意

注意:

return パラメータを使う場合、この関数は内部的に出力バッファリングを使います。 そのため、ob_start() コールバック関数の中では使えません。

生成される HTML マークアップは、変わる可能性があります。

参考