钩子文档

sanitize_file_name

💡 云策文档标注

概述

sanitize_file_name 是一个 WordPress 过滤器,用于在文件名被 sanitize_file_name() 函数清理后,进一步过滤或修改已清理的文件名字符串。

关键要点

  • 过滤器钩子名称为 'sanitize_file_name',用于处理已清理的文件名。
  • 接收两个参数:$filename(已清理的文件名)和 $filename_raw(原始文件名)。
  • 常用于自定义文件名清理逻辑,例如添加前缀、后缀或进一步字符替换。

代码示例

add_filter( 'sanitize_file_name', 'custom_sanitize_filename', 10, 2 );
function custom_sanitize_filename( $filename, $filename_raw ) {
    // 自定义逻辑:例如将文件名转换为小写
    $filename = strtolower( $filename );
    return $filename;
}

注意事项

  • 此过滤器在 sanitize_file_name() 函数内部调用,确保文件名安全后应用。
  • 从 WordPress 2.8.0 版本开始引入,兼容性良好。
  • 相关函数 sanitize_file_name() 位于 wp-includes/formatting.php 中,用于基本文件名清理(如替换空格为短横线)。

📄 原文内容

Filters a sanitized filename string.

Parameters

$filenamestring
Sanitized filename.
$filename_rawstring
The filename prior to sanitization.

Source

return apply_filters( 'sanitize_file_name', $filename, $filename_raw );

Changelog

Version Description
2.8.0 Introduced.