PHP マニュアル
前のページ |  | 次のページ

# highlight_string

(PHP 4, PHP 5)

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

## 説明

mixed highlight_string ( string str [, bool return] )

highlight_string() 関数は、PHP 組込みの 構文ハイライタで定義されたカラーを使用して str を構文ハイライト表示したものを出力します。

2 番目のパラメータ return が `TRUE` の場合、 ハイライト表示されたコードを画面に表示するかわりに、そのコード自体を highlight_string() 関数の返り値とします。 2 番目のパラメータが `TRUE` ではない場合、highlight_string() の返り値は成功時に `TRUE` 、失敗時に `FALSE` となります。

> 注意: この関数は、 このパラメータに対して内部的に出力バッファリングを使用しています。 そのため、ob_start() コールバック関数の中で使用することはできません。

例 1. highlight_string() の例
`<?php highlight_string('<?php phpinfo(); ?>'); ?>`
上の例の出力は（PHP 4 では）以下のようになります。
    <code><font color="#000000">
    <font color="#0000BB">&lt;?php phpinfo</font><font color="#007700">(); </font><font color="#0000BB">?&gt;</font>
    </font>
    </code>
上の例の出力は（PHP 5 では）以下のようになります。
    <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 パラメータは PHP 4.2.0 以降で有効です。 それ以前は、常にこのパラメータのデフォルト値である `FALSE` と同じ動作でした。

highlight_file() も参照ください。

前のページ | ホーム | 次のページ
highlight_file | 上に戻る | ignore_user_abort