原型:

sanitize_text_field( string $str )

作用:

清理用户输入或者从数据库中获取的字符串。具体会做如下事情:

  • 检查无效的 UTF-8 字符

  • 将 < 转换成 HTML 实体

  • 去掉所有标签

  • 删除所有换行符,tab 键和额外的空格

  • 去掉八位字节

参数

$str (string) 类型,此参数是必须的,表示需要处理的字符串

返回值

(string) 类型,清理后的字符串。

基本用法:

1
<?php $str = sanitize_text_field( $str ) ?>

源文件

wp-includes/formatting.php

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
<?php
...
function sanitize_text_field( $str ) {
    $filtered = _sanitize_text_fields( $str, false );
 
    /**
     * Filters a sanitized text field string.
     *
     * @since 2.9.0
     *
     * @param string $filtered The sanitized string.
     * @param string $str      The string prior to being sanitized.
     */
    return apply_filters( 'sanitize_text_field', $filtered, $str );
}

其他

官方文档:https://developer.wordpress.org/reference/functions/sanitize_text_field/