Bricks 中文文档：bricks/svg/bypass_sanitization

标签TAGS: 
2026年8月30日

📄 原始资料  |  展开查看原始 JSON（bricks-svg-bypass_sanitization.json）{ “name”: “bricks/svg/bypass_sanitization”, “kind”: “filter”, “url”: “https://academy.bricksbuilder.io/developer/hooks/filters/bricks-svg-bypass_sanitization/”, “scraped_at”: “2026-08-29”, “hook_name”: “bricks/svg/bypass_sanitizati…

📄 原始资料  |  展开查看原始 JSON（bricks-svg-bypass_sanitization.json） 
{
  "name": "bricks/svg/bypass_sanitization",
  "kind": "filter",
  "url": "https://academy.bricksbuilder.io/developer/hooks/filters/bricks-svg-bypass_sanitization/",
  "scraped_at": "2026-08-29",
  "hook_name": "bricks/svg/bypass_sanitization",
  "description": {
    "en": "Determines whether to bypass the SVG sanitization process when uploading SVG files. This can be useful if you need to upload SVGs with complex features (like animations or scripts) that the sanitizer would normally strip out, but it comes with security risks.",
    "zh": "确定在上传 SVG 文件时是否绕过 SVG 清理过程。如果你需要上传具有复杂功能（如动画或脚本）的 SVG（清理器通常会剥离这些功能），这可能很有用，但会带来安全风险。"
  },
  "parameters": [
    {
      "name": "bypass",
      "type": "bool",
      "type_zh": null,
      "description": {
        "en": "Whether to bypass sanitization. Default is false .",
        "zh": "是否绕过清理。默认为 false。"
      }
    },
    {
      "name": "file",
      "type": "array",
      "type_zh": null,
      "description": {
        "en": "Array containing file information (e.g., tmp_name , type ).",
        "zh": "包含文件信息的数组（例如 tmp_name、type）。"
      }
    }
  ],
  "example_usage": "add_filter( 'bricks/svg/bypass_sanitization', function( $bypass, $file ) {\n    // Example: Bypass sanitization for trusted users only\n    if ( current_user_can( 'administrator' ) ) {\n        return true;\n    }\n\n\n    return $bypass;\n}, 10, 2 );"
}

前言

确定在上传 SVG 文件时是否绕过 SVG 清理过程。如果你需要上传具有复杂功能（如动画或脚本）的 SVG（清理器通常会剥离这些功能），这可能很有用，但会带来安全风险。

用法

将代码加入子主题的 functions.php：

add_filter( 'bricks/svg/bypass_sanitization', function( $bypass, $file ) {
    // Example: Bypass sanitization for trusted users only
    if ( current_user_can( 'administrator' ) ) {
        return true;
    }


    return $bypass;
}, 10, 2 );

参数

  • $bypass (bool)：是否绕过清理。默认为 false。
  • $file (array)：包含文件信息的数组（例如 tmp_name、type）。

示例代码

筛选返回值

add_filter( 'bricks/svg/bypass_sanitization', function( $bypass, $file ) {
    // Example: Bypass sanitization for trusted users only
    if ( current_user_can( 'administrator' ) ) {
        return true;
    }


    return $bypass;
}, 10, 2 );

根据条件短路返回原值

根据条件跳过或修改返回值：

add_filter( 'bricks/svg/bypass_sanitization', function( $value, $bypass ) {
    if ( is_admin() ) { return $value; }
    // TODO: custom logic here
    return $value;
} );

补充说明

更多细节可参考 官方文档。