HTML Purifier 使用教程

HTML Purifier 使用教程

htmlpurifierStandards compliant HTML filter written in PHP项目地址:https://gitcode.com/gh_mirrors/ht/htmlpurifier

1. 项目的目录结构及介绍

HTML Purifier 是一个用于过滤和净化 HTML 的开源项目，其目录结构如下：

htmlpurifier/
├── configdoc/
├── docs/
├── library/
│   ├── HTMLPurifier/
│   └── HTMLPurifier.php
├── maintenance/
├── tests/
├── tools/
├── INSTALL
├── LICENSE
├── README
└── TODO

• configdoc/: 包含配置文档的目录。
• docs/: 开发者文档和示例代码。
• library/: 核心库文件，包括 HTMLPurifier 类和相关子类。
• maintenance/: 维护工具和脚本。
• tests/: 测试文件。
• tools/: 开发工具。
• INSTALL: 安装指南。
• LICENSE: 许可证文件。
• README: 项目介绍和基本使用说明。
• TODO: 待办事项。

2. 项目的启动文件介绍

HTML Purifier 的启动文件是 library/HTMLPurifier.php。这个文件是整个库的入口点，包含了主要的类定义和初始化代码。

require_once 'HTMLPurifier.php';

$config = HTMLPurifier_Config::createDefault();
$purifier = new HTMLPurifier($config);
$clean_html = $purifier->purify($dirty_html);

在这个示例中，我们首先引入 HTMLPurifier.php 文件，然后创建一个默认配置对象，并使用该配置实例化 HTMLPurifier 类。最后，调用 purify 方法来净化输入的 HTML 代码。

3. 项目的配置文件介绍

HTML Purifier 的配置文件是一个 HTMLPurifier_Config 对象，它允许用户自定义过滤规则和行为。配置文件的详细文档可以在 configdoc/ 目录中找到。

以下是一个基本的配置示例：

$config = HTMLPurifier_Config::createDefault();
$config->set('HTML.Doctype', 'HTML 4.01 Transitional');
$config->set('Attr.EnableID', true);
$config->set('HTML.Allowed', 'p,br,b,i,a[href]');

$purifier = new HTMLPurifier($config);
$clean_html = $purifier->purify($dirty_html);

在这个示例中，我们设置了文档类型、启用了 ID 属性，并指定了允许的 HTML 标签和属性。通过这些配置，可以精确控制 HTML Purifier 的过滤行为。

---

以上是 HTML Purifier 的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用 HTML Purifier。

htmlpurifierStandards compliant HTML filter written in PHP项目地址:https://gitcode.com/gh_mirrors/ht/htmlpurifier