将HTML内容作为纯文本代码展示的PHP教程-php教程-PHP中文网

将HTML内容作为纯文本代码展示的PHP教程

聖光之護

发布： 2025-11-06 11:52:03

原创

312人浏览过

将HTML内容作为纯文本代码展示的PHP教程

本教程详细介绍了如何使用php将html文件内容读取出来，并将其作为纯文本（即代码形式）在网页或邮件中展示。核心方法是利用`htmlspecialchars()`函数对html实体进行转义，并结合`preg_replace()`将换行符转换为html的`
`标签，从而确保原始代码结构和格式的正确呈现。

在Web开发中，有时我们需要展示HTML文件的原始代码，而不是让浏览器解析并渲染它。例如，在教程文档中显示代码示例，或者通过邮件发送代码片段。直接读取HTML文件内容并输出，浏览器会将其视为待渲染的HTML，导致无法看到原始标签和结构。本文将指导您如何正确地将HTML内容转换为可展示的纯文本代码。

理解问题所在

当您尝试读取一个HTML文件（例如myFile.html）的内容并直接输出时，如：

ob_start();
include ("myFile.html");
$html = ob_get_contents();
echo $html;

登录后复制

浏览器会解析$html中的所有HTML标签，并按照其定义进行渲染。这意味着您看到的将是渲染后的页面效果，而不是构成页面的原始代码。即使尝试使用<pre>标签包裹内容，如"<pre>".$html."</pre>"，也只能保留文本的预格式化（如空格和换行），但HTML标签本身仍然会被浏览器解析。要展示原始代码，我们需要对HTML内容进行“无害化”处理。

核心解决方案：HTML实体转义与换行符处理

要将HTML内容作为纯文本代码展示，需要解决两个关键问题：

立即学习“PHP免费学习笔记（深入）”；

芦笋演示

一键出成片的录屏演示软件，专为制作产品演示、教学课程和使用教程而设计。

查看详情

HTML实体转义： 将HTML标签中的特殊字符（如<、>、&等）转换为对应的HTML实体（如、&）。这样，浏览器就不会将它们识别为HTML标签，而是将其作为普通文本字符显示。
换行符转换： 在HTML中，多个连续的空白字符（包括换行符）通常会被折叠成一个空格。为了在纯文本显示时保留原始的换行效果，我们需要将文件内容中的转换为HTML的 标签，或者在<pre>标签内部显示。考虑到更广泛的适用性（例如，在非<pre>环境中也保持换行），转换为 是一种有效的方法。

实现步骤与示例代码

下面是实现这一目标的PHP代码示例：

<?php

// 1. 定义HTML文件路径
// 假设您的myFile.html文件与此PHP脚本在同一目录下
$filePath = __DIR__ . '/myFile.html';

// 确保文件存在，否则给出提示
if (!file_exists($filePath)) {
    die("错误：HTML文件 'myFile.html' 不存在于指定路径。");
}

// 2. 读取HTML文件的全部内容
$content = file_get_contents($filePath);

// 3. 对HTML内容进行转义，将特殊字符转换为HTML实体
// 这一步是核心，确保浏览器不会解析原始HTML标签
$escapedContent = htmlspecialchars($content, ENT_QUOTES, 'UTF-8');

// 4. 将原始的换行符（
）转换为HTML的<br>标签
// 这样在浏览器中显示时，每一行都会正确地换行
// 使用PHP_EOL可以确保跨操作系统的换行符兼容性
$finalOutput = preg_replace('/
/', '<br>' . PHP_EOL, $escapedContent);

// 5. 输出处理后的内容
// 如果是在网页中显示，直接echo即可
// 如果是发送邮件，将$finalOutput作为邮件正文发送
echo $finalOutput;

?>

登录后复制

代码解释：

$filePath = __DIR__ . '/myFile.html';: 定义了要读取的HTML文件的路径。__DIR__是一个魔术常量，表示当前脚本文件所在的目录，这使得路径定义更加灵活和可靠。
file_get_contents($filePath);: 这是一个高效的函数，用于将整个文件的内容读取到一个字符串中。
htmlspecialchars($content, ENT_QUOTES, 'UTF-8');:
- htmlspecialchars()函数将预定义的HTML实体转换为字符。
- ENT_QUOTES参数确保双引号和单引号也会被转义（分别转为"和'），这在显示属性值时很有用。
- 'UTF-8'指定了输入内容的字符编码，避免乱码问题。
preg_replace('/ /', ' ' . PHP_EOL, $escapedContent);:
- preg_replace()函数用于执行正则表达式的搜索和替换。
- '/ /'是正则表达式模式，匹配所有的换行符。
- ' ' . PHP_EOL是替换字符串。它将每个替换为 标签，并紧跟着一个PHP_EOL（PHP的跨平台换行符）。PHP_EOL在这里的作用主要是为了在源代码级别保持替换后的可读性，对最终HTML渲染效果影响不大，因为 已经完成了换行。
- 关于引号的说明： 在正则表达式模式中，如果使用双引号，反斜杠需要被转义，例如"/\n/"。但使用单引号时，'/ /'即可。通常，使用单引号定义简单的正则表达式模式是更简洁且性能略优的选择。

注意事项与应用场景

字符编码： 始终确保htmlspecialchars()函数中的字符编码参数与您HTML文件的实际编码一致，以避免显示乱码。
性能： 对于非常大的HTML文件，file_get_contents()和字符串处理可能会消耗较多内存和CPU。在极端情况下，可能需要考虑分块读取或流式处理。
邮件发送： 如果您通过邮件发送这些内容，请确保邮件客户端能够正确渲染HTML格式的邮件。通常，您需要将邮件的Content-Type设置为text/html。
<pre>标签的使用： 如果您希望在网页上以等宽字体显示代码，并保留原始的空格和缩进，可以将最终输出的$finalOutput（或只经过htmlspecialchars处理后的$escapedContent）包裹在<pre>标签中。在这种情况下，将替换为 的步骤可以省略，因为<pre>标签会自动保留换行。
```
// 如果希望在<pre>标签中显示，可以这样处理：
$content = file_get_contents($filePath);
$escapedContent = htmlspecialchars($content, ENT_QUOTES, 'UTF-8');
echo "<pre>" . $escapedContent . "</pre>";
```
登录后复制
这种方式更符合展示代码的语义，且通常是首选方法。

总结

通过file_get_contents()读取HTML文件内容，接着使用htmlspecialchars()进行实体转义，最后结合preg_replace()（或直接利用<pre>标签的特性）处理换行符，我们可以有效地将HTML文件的原始代码作为纯文本展示出来。理解这些核心函数的用途及其参数，是实现这一功能的关键。根据您的具体需求（例如，是否需要等宽字体、是否需要精确控制每行显示），可以选择最适合的实现方式。

以上就是将HTML内容作为纯文本代码展示的PHP教程的详细内容，更多请关注php中文网其它相关文章！