参数
- $meta_key
-
(string) (必填) Metadata key(元数据键)
- $meta_value
-
(mixed) (必填) 要清理的元数据值。
- $object_type
-
(string) (必填) 对象元数据的类型，接受带有关联元数据表的“post”、“comment”、“term”、“user”或任何其他对象类型。
- $object_subtype
-
(string) (可选) 对象类型的子类型。
默认值: ''
返回
(mixed) 净化清理后的 $meta_value
说明
- 这个函数应用过滤器，可以被钩住以执行特定的元数据类型和键的特定净化清理程序。它本身不对任何东西进行清理。自定义过滤器必须被钩住来做这个工作。过滤器挂钩标签的形式为 “
sanitize_{$meta_type}_meta_{$meta_key}“ - 该函数被 add_metadata() 和 update_metadata() 调用。
源码
更新日志
| 版本 | 描述 |
|---|---|
| 4.9.8 | 添加了$object_subtype参数 |
| 3.1.3 | 开始引入 |
使用示例
示例
$clean_value = sanitize_meta( 'birth-year', $user_input, 'user' ); function wpdocs_sanitize_birth_year_meta( $year ) { $now = date( 'Y' ); $then = $now - 115; // No users older than 115. if ( $then > $year || $year > $now ) { wp_die( __( 'Invalid entry, go back and try again.', 'textdomain' ) ); } return $year; } add_filter( 'sanitize_user_meta_birth-year', 'wpdocs_sanitize_birth_year_meta' );