PHP highlight_file()関数

PHP Misc 参考手册PHP Misc リファレンスマニュアル

例

テストファイル("test.php")に PHP 構文のハイライトを適用します:

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

上記コードのブラウザ出力は次のとおりです(ファイルの内容によって異なります):

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

上記コードのHTML出力は次のとおりです(ソースコードを表示):

<html>
<body>
<code><span style="color: #000000">
&lt;html&gt;
<br />&lt;body&gt;
<br /><span style="color: #0000BB">&lt;?php
<br /></span><span style="color: #0053A6">echo&nbsp;(</span><span style="color: #DD0000">"test.php"</span><span style="color: #0053A6">);
<br /></span><span style="color: #0000BB">?&gt;
<br /></span>&lt;/body&gt;
<br />&lt;/html&gt;</span>
</code>
</body>
</html>

サンプルを実行 »

定義と使用法

highlight_file() 関数はファイルに対して PHP 構文のハイライトを適用します。構文は HTML タグを使用してハイライトされます。

ヒント:ハイライトに使用する色は、php.ini ファイルで設定するか、ini_set() 関数を呼び出して設定できます。

注記:この関数を使用すると、パスワードやその他の機密情報を含むファイル全体が表示されます。


構文

highlight_file(filename,return)

パラメータ 説明
filename 必須です。表示するファイルを指定します。
return 省略可能です。このパラメータを TRUE に設定すると、関数はハイライトされたコードを直接出力せずに文字列として返します。デフォルトは FALSE です。

技術詳細

戻り値: もしreturnパラメータが TRUE に設定されている場合、関数はハイライトされたコードを直接出力せずに文字列として返します。それ以外の場合、成功した場合は TRUE を返し、失敗した場合は FALSE を返します。
PHP バージョン: 4+
更新履歴: PHP 4.2.1 以降、この関数は safe_mode と open_basedir の影響も受けるようになりました。ただし、safe_mode は PHP 5.4 で削除されました。

PHP 4.2.0 で return パラメータが追加されました。


PHP Misc 参考手册PHP Misc リファレンスマニュアル その他の拡張