简介

清理用户输入或者从数据库中获取的字符串。

检查是否合法的 UTF-8 字符，将 < 转换成 HTML 实体，去掉所有标签，删除所有换行符，占位符，以及额外的空格，去掉八位字节。

用法

<?php sanitize_text_field($string); ?>

参数

$string
(string) (required) 将要清理的字符串。
Default: None

返回值

(string) 
清理之后的字符串

修改记录

Since: 2.9.0

源文件

wp-includes/formatting.php.

---

WordPress函数：sanitize_text_field( )

原型：

sanitize_text_field( string $str )

作用：

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

• 检查无效的 UTF-8 字符
• 将 < 转换成 HTML 实体
• 去掉所有标签
• 删除所有换行符，tab 键和额外的空格
• 去掉八位字节

参数

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

返回值

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

基本用法：

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

源文件

wp-includes/formatting.php

<?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 );
}