highlight_file

(PHP 4, PHP 5, PHP 7)

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

説明

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

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

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

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

パラメータ

filename

ハイライト表示する PHP ファイルへのパス。

return

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

返り値

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

注意

警告

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

注意:

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

参考