PHP highlight_file() 函数

PHP 杂项函数

定义和用法

highlight_file() 函数输出一个带有 PHP 语法高亮的文件。语法高亮是通过使用 HTML 标签来实现的。

提示：用于语法高亮的颜色可以在 php.ini 文件中设置，或者使用 ini_set() 函数来设置。

注意：当使用此函数时，整个文件都会被显示——包括密码和任何其他敏感信息！

实例

使用测试文件（"test.php"）来输出带有 PHP 语法高亮的文件：

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

上述代码的浏览器输出可能是（取决于文件中的内容）：

<html>
<body>
<?php
"color: #007700">echo "COLOR: #007700">("COLOR: #dd0000">"test.php""COLOR: #007700">);
"COLOR: #0000bb">?>
</body>
</html>

上面代码的 HTML 输出可能是（请查看源代码）：

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

语法

highlight_file(filename,return)
参数 描述
filename 必需。指定要高亮的文件。
return

可选。如果设置为 TRUE，此函数将返回高亮的代码作为字符串，而不是将其打印出来。

默认是 FALSE。

说明

本函数通过使用 PHP 语法高亮程序中定义的颜色，输出或返回包含在 filename 中的代码的语法高亮版本。

许多服务器被配置为对带有 phps 后缀的文件进行自动高亮处理。例如，在查看 example.phps 时，将显示该文件被语法高亮显示的源代码。要启用该功能，请把下面这一行添加到 httpd.conf：

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

返回值

如果 return 参数被设置为 true，那么该函数会返回被高亮处理的代码，而不是输出它们。否则，若成功，则返回 true，失败则返回 false。

技术细节

返回值： 如果 return 参数设置为 TRUE，此函数将返回高亮的代码作为字符串，而不是将其打印出来。否则，成功时返回 TRUE，失败时返回 FALSE。
PHP 版本： 4+
PHP 更新日志：

PHP 4.2.1 - 此函数现在也受 safe_mode 和 open_basedir 的影响。

PHP 5.4 - safe_mode 被弃用并移除。

PHP 4.2 - 添加了 return 参数。

PHP 杂项函数