highlight_file() 関数は、 filename の中のコードを構文ハイライト表示して 出力します。色は、PHP 組込の構文ハイライタで定義されているものを使用します。
2 番目のパラメータ return が TRUE の場合、 ハイライト表示されたコードを画面に表示するかわりに、そのコード自体を highlight_file() 関数の返り値とします。 2 番目のパラメータが TRUE ではない場合、highlight_file() の返り値は成功時に TRUE 、失敗時に FALSE となります。
注意: この関数は、 このパラメータに対して内部的に出力バッファリングを使用しています。 そのため、ob_start() コールバック関数の中で使用することはできません。
注意: return パラメータは PHP 4.2.0 以降で有効です。 それ以前は、常にこのパラメータのデフォルト値である FALSE と同じ動作でした。
注意: PHP 4.2.1 以降、この関数は safe_mode および open_basedir の影響を受けます。
| 注意 |
highlight_file() 関数を使用する場合には、 パスワードやその他潜在的なセキュリティ上の危険を生む類の重要な 情報を不注意で公開してしまわないように注意する必要があります。 |
多くのサーバでは、拡張子が phps のファイルは 自動的に構文ハイライト表示されるように設定されています。例えば example.phps のようなファイルは、構文ハイライト したソースファイルとして表示されます。これを有効にするには、 httpd.conf に以下のような行を追加します。
AddType application/x-httpd-php-source .phps |
highlight_string() も参照ください。