当前浏览:首页 / WordPress函数 / sanitize_file_name()

sanitize_file_name( string $filename )

清理文件名,用破折号替换空格

file

kses 清理

name

sanitize 清理more...


描述

删除某些操作系统上文件名中非法的特殊字符,以及需要特殊转义才能在命令行操作的特殊字符。将空格和连续破折号替换为单个破折号。从文件名的开头和结尾修剪句点、破折号和下划线。不能保证此函数将返回允许上传的文件名。


参数

$filename

(string) (必填) 要清理的文件名。


返回

(string) 经过净化清理的文件名。


说明

特殊字符在从文件名中删除之前通过sanitize_file_name_chars过滤器,允许插件更改哪些字符被视为无效。sanitize_file_name()完成其工作后,它将经过净化清理的文件名传递给sanitize_file_name过滤器。



源码

查看源码 官方文档


更新日志

版本描述
2.1.0开始引入

使用示例

  • 示例1

    当您在文件名中写入任何特殊字符(如括号、逗号等)时,该函数sanitize_file_name()会自动从该文件名中删除。

    例如:

    <?php
    $sanfilename = sanitize_file_name('[test],.php');
    echo $sanfilename;
    ?>
    

    在上面的代码中使用了括号和逗号,之后sanitize_file_name()函数去掉了括号和逗号,最后显示的结果是test.php。