highlight_file

(PHP 4, PHP 5, PHP 7, PHP 8)

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

説明

highlight_file(string $filename, bool $return = false): string|bool

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

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

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

パラメータ

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

戻り値

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

変更履歴

バージョン	説明
8.3.0	結果のHTMLが変更されました。

注意

警告

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

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

参考

highlight_string() - 文字列の構文ハイライト表示
ハイライトに関する INI 設定

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 1 note

down

csst0266 at cs dot uoi dot gr ¶

20 years ago

Here is a simple, yet useful, tip... Issuing the following command under a Unix-like OS:

ln -s your_script.php your_script.phps

Will result in the creation of a symbolic link (called your_script.phps) to the source code (your_script.php). This way you have (apart from the source code .php) the highlighted version of your script (.phps) accessible via your web browser.

＋add a note