本文旨在指导开发者如何在HTML页面中安全地展示PHP代码片段，而避免PHP解释器自动执行这些代码。我们将探讨多种方法，从手动字符实体编码到利用PHP内置的htmlentities()、highlight_string()和highlight_file()函数，特别推荐使用后两者，它们不仅能防止代码执行，还能提供美观的语法高亮效果，提升代码可读性。
理解问题：PHP代码的自动执行
当一个文件被命名为.php并由web服务器的php解释器处理时，任何位于<?php和?>标签之间的内容都会被视为php代码并执行。这对于构建动态网页是必需的，但当我们的目标仅仅是向用户展示php代码本身，而不是运行它时，这种行为就成了障碍。例如，直接将php代码放入<pre>或<code>标签内，php解释器仍然会尝试执行它，导致代码无法按原样显示。
解决方案一：手动字符实体编码
PHP解释器识别<?php作为代码块的起始标记。要阻止其执行，最直接的方法就是将这些特殊字符转换为HTML实体。这意味着将<替换为。对于<?php，你需要将其表示为。
例如，要显示以下PHP代码：
<?php echo "Hello world!"; ?>
你需要将其在HTML文件中写成：
<pre> <?php echo "Hello world!"; ?> </pre>
这种方法虽然有效，但手动编码所有特殊字符既繁琐又容易出错，尤其当代码片段较长时。
立即学习“PHP免费学习笔记（深入）”；
解决方案二：使用htmlentities()函数
PHP提供了一个强大的内置函数htmlentities()，它可以将字符串中所有适用的字符转换为HTML实体。这包括<、>、&、”等，能够有效防止浏览器将内容解析为HTML标签或PHP代码。
<?php $phpCode = '<?php echo "<h2>PHP is Fun!</h2>"; echo "Hello world!<br>"; echo "I/'m about to learn PHP!<br>"; echo "This ", "string ", "was ", "made ", "with multiple parameters."; ?>'; echo "<pre>"; echo htmlentities($phpCode); echo "</pre>"; ?>
注意事项：
- htmlentities()函数默认会转换所有HTML特殊字符。
- 此方法能确保代码按原样显示，但不会提供语法高亮功能。
解决方案三：利用highlight_string()和highlight_file()进行语法高亮
PHP专门为展示PHP源代码提供了两个非常实用的函数：highlight_string()和highlight_file()。这两个函数不仅会进行必要的字符实体编码，还会自动为PHP代码应用语法高亮，使其在视觉上更具可读性，类似于IDE中的代码编辑器。
1. highlight_string(string $string)
highlight_string()函数用于高亮显示一个字符串形式的PHP代码。
示例代码：
<?php $phpCode = '<?php echo "<h2>PHP is Fun!</h2>"; echo "Hello world!<br>"; echo "I/'m about to learn PHP!<br>"; echo "This ", "string ", "was ", "made ", "with multiple parameters."; ?>'; // highlight_string() 会自动将输出包裹在 <code> 和 <span style="..."> 标签中 highlight_string($phpCode); ?>
运行上述PHP脚本，你将看到一个带有语法高亮的代码块，而不会执行其中的echo语句。
2. highlight_file(string $filename)
highlight_file()函数用于高亮显示指定文件中的PHP代码。这是展示独立PHP文件内容时的理想选择，因为它能更好地实现内容与逻辑的分离。
假设你有一个名为example.php的文件，内容如下：
// example.php
<?php
function greet($name) {
echo "Hello, " . $name . "!";
}
greet("World");
?>
要在另一个PHP文件中显示example.php的内容（不执行），你可以这样做：
<?php
// display_code.php
echo "<h3>example.php 的代码内容：</h3>";
highlight_file('example.php');
?>
注意事项：
- highlight_string()和highlight_file()的输出默认包含HTML <code> 标签和内联样式。
- 你可以通过修改php.ini中的highlight.syntax系列配置项来定制高亮颜色。
- 使用highlight_file()可以保持待显示代码的独立性，避免在同一个文件中混淆执行代码和显示代码。
推荐与最佳实践
对于需要在HTML中展示PHP代码片段的场景，强烈推荐使用highlight_string()或highlight_file()函数。它们提供了以下优势：
- 自动化处理： 无需手动编码，简化开发。
- 语法高亮： 提升代码的可读性和美观性。
- 专业性： 呈现效果更符合专业开发者的习惯。
- 分离关注点： 特别是highlight_file()，允许你将要展示的代码存储在单独的文件中，与执行代码逻辑清晰分离。
如果你的需求超越了PHP内置的高亮功能，例如需要支持多种编程语言的高亮，可以考虑使用第三方库，如GeSHi (Generic Syntax Highlighter) 等。
总结
在HTML中展示PHP代码片段而不执行它，关键在于阻止PHP解释器识别并处理<?php和?>标签。通过将这些特殊字符转换为HTML实体，可以有效地实现这一目标。PHP提供了htmlentities()函数用于通用字符转换，而highlight_string()和highlight_file()函数则是专门为PHP代码展示设计的，它们不仅能防止执行，还能提供美观的语法高亮效果。在实际开发中，优先选择highlight_string()或highlight_file()，以获得最佳的用户体验和代码维护性。
以上就是在HTML中展示PHP代码片段：避免自动执行的专业指南的详细内容，更多请关注php中文网其它相关文章！