钩子文档

sanitize_text_field

💡 云策文档标注

概述

sanitize_text_field 是一个 WordPress 过滤器钩子,用于在字符串被 sanitize_text_field() 函数清理后,对清理后的字符串进行过滤。它允许开发者自定义清理逻辑。

关键要点

  • 这是一个过滤器钩子,名称为 'sanitize_text_field'。
  • 它接收两个参数:$filtered(清理后的字符串)和 $str(原始字符串)。
  • 主要用于扩展或修改 sanitize_text_field() 函数的清理行为。
  • 在 WordPress 2.9.0 版本中引入。

代码示例

return apply_filters( 'sanitize_text_field', $filtered, $str );

注意事项

此钩子与 sanitize_text_field() 函数紧密相关,常用于安全处理用户输入或数据库数据。


📄 原文内容

Filters a sanitized text field string.

Parameters

$filteredstring
The sanitized string.
$strstring
The string prior to being sanitized.

Source

return apply_filters( 'sanitize_text_field', $filtered, $str );

Changelog

Version Description
2.9.0 Introduced.