PHP highlight_file()関数

定義と用法

highlight_file()関数はファイルに対して文法ハイライト表示を行います。

文法

highlight_file(filename,return)
パラメータ 説明
filename 必須です。ハイライト処理するPHPファイルのパスを指定します。
return オプションです。trueに設定すると、この関数はハイライト処理されたコードを返します。

説明

この関数はPHP文法ハイライトプログラムで定義された色を使用して、 filename 内のコードの文法ハイライト版を設定しています。

多くのサーバーが phps 後缀のファイルに対して自動的にハイライト処理を行います。例えば、example.phpsを表示する際には、そのファイルが文法ハイライトされたソースコードが表示されます。この機能を有効にするには、以下の行を追加してください httpd.conf

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

返り値

もし return パラメータが true に設定されている場合、この関数はハイライトされたコードを返しますが、それを表示しません。それ以外の場合、成功した場合に true、失敗した場合に false を返します。

ヒントとコメント

警告:highlight_file() 関数を使用する際は、パスワードや他の種類の機密情報を誤って漏らさないように注意してください。それがあれば、潜在的なセキュリティリスクが発生する可能性があります。

"test.php":

<html>
<body>
<?php
highlight_file("test.php");
?>
</body>
</html>

出力:

<html> 
<body> 
<?php 
highlight_file("test.php");
?>
</body> 
</html>

ブラウザで確認するとこんな感じになります:

<html>
<body>
<code>
<span style="color: #000000"><html>
<br />
<body>
<br />
<span style="color: #0000BB"><?php
<br />highlight_file</span>
<span style="color: #007700">(</span>
<span style="color: #DD0000">"test.php"</span>
<span style="color: #007700">);<br /></span>
<span style="color: #0000BB">?><br /></span>
</body>
<br />
</html></span>
</code>
</body>
</html>