Class yii\helpers\BaseHtmlPurifier

继承yii\helpers\BaseHtmlPurifier
子类yii\helpers\HtmlPurifier
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/helpers/BaseHtmlPurifier.php

BaseHtmlPurifier 为 yii\helpers\HtmlPurifier 提供了具体的实现方法.

不要使用 BaseHtmlPurifier. 改用 yii\helpers\HtmlPurifier.

公共方法

隐藏继承的方法

方法描述定义在
process() 通过 HTMLPurifier 传递标记, 使其可以安全的输出给最终用户. yii\helpers\BaseHtmlPurifier

受保护的方法

隐藏继承的方法

方法描述定义在
configure() 允许扩展 HtmlPurifier 类去设置一些默认的配置选项. yii\helpers\BaseHtmlPurifier

方法详情

configure() protected static 方法 (可用自版本: 2.0.3)

允许扩展 HtmlPurifier 类去设置一些默认的配置选项.

protected static void configure ( $config )
$config \HTMLPurifier_Config
process() public static 方法

通过 HTMLPurifier 传递标记, 使其可以安全的输出给最终用户.

public static string process ( $content, $config null )
$content string

需要过滤的 HTML 内容.

$config array|Closure|null

用于 HtmlPurifier 的配置. 如果未指定或为null, 则将使用默认配置. 你可以使用数组或匿名函数来提供配置选项:

  • 以数组的形式将传递给HTMLPurifier_Config::create()方法.
  • 匿名函数将在配置创建后被调用. 签名应该是function($config), $config将是HTMLPurifier_Config的一个示例.

    以下是此类功能的用法示例:

    // 在`img`元素上允许 HTML5 数据属性`data-type`.
    $content = HtmlPurifier::process($content, function ($config) {
      $config->getHTMLDefinition(true)
             ->addAttribute('img', 'data-type', 'Text');
    });
    
return string

过滤后的 HTML 内容.