ファイルの構文ハイライト表示

説明

mixed highlight_file ( string $filename [, bool $return = false ] )

filename の中のコードを構文ハイライト表示して出力します。色は、PHP 組込の構文ハイライタで定義されているものを使用します。

多くのサーバでは、拡張子が phps のファイルは自動的に構文ハイライト表示されるように設定されています。例えば example.phps のようなファイルは、構文ハイライトしたソースファイルとして表示されます。これを有効にするには、 httpd.conf に以下のような行を追加します。

AddType application/x-httpd-php-source .phps

パラメータ

filename: ハイライト表示する PHP ファイルへのパス。
return: このパラメータを TRUE にすると、この関数はハイライトされたコードを返します。

返り値

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

変更履歴

バージョン	説明
4.2.1	この関数は safe_mode および open_basedir の影響を受けます。
4.2.0	パラメータ `return` が追加されました。

注意

警告

highlight_file() 関数を使用する場合には、パスワードやその他潜在的なセキュリティ上の危険を生む類の重要な情報を不注意で公開してしまわないように注意する必要があります。

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

参考

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