PHP highlight_file() 函数

定义和用法

highlight_file() 函数对文件进行语法高亮显示。

语法

  1. highlight_file(filename,return)
参数 描述
filename 必需。要进行高亮处理的 PHP 文件的路径。
return 可选。如果设置 true,则本函数返回高亮处理的代码。

说明

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

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

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

返回值

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

提示和注释

警告:需要注意的是,在使用 highlight_file() 函数时,请不要因为疏忽而泄诸如密码或其他类型的敏感信息,否则会出现潜在的安全风险。

例子

"test.php":

  1. <html>
  2. <body>
  3. <?php
  4. highlight_file("test.php");
  5. ?>
  6. </body>
  7. </html>

输出:

  1. <html>
  2. <body>
  3. <?php
  4. highlight_file("test.php");
  5. ?>
  6. </body>
  7. </html>

在浏览器中查看的结果类似这样:

  1. <html>
  2. <body>
  3. <code>
  4. <span style="color: #000000">&lt;html&gt;
  5. <br />
  6. &lt;body&gt;
  7. <br />
  8. <span style="color: #0000BB">&lt;?php
  9. <br />highlight_file</span>
  10. <span style="color: #007700">(</span>
  11. <span style="color: #DD0000">"test.php"</span>
  12. <span style="color: #007700">);<br /></span>
  13. <span style="color: #0000BB">?&gt;<br /></span>
  14. &lt;/body&gt;
  15. <br />
  16. &lt;/html&gt;</span>
  17. </code>
  18. </body>
  19. </html>