钩子文档

edit_user_{$field}

💡 云策文档标注

概述

edit_user_{$field} 是一个动态过滤器钩子,用于在编辑上下文中过滤用户字段值。它允许开发者修改特定用户字段(如 user_login、user_email 等)的值,基于用户ID进行自定义处理。

关键要点

  • 这是一个动态钩子,$field 部分指代带前缀的用户字段名,例如 'user_login'、'user_email'、'first_name' 等。
  • 钩子接受两个参数:$value(用户字段的当前值)和 $user_id(用户ID),用于在过滤时提供上下文。
  • 常用于 sanitize_user_field() 函数中,在编辑用户数据时进行字段值的清理和验证。

代码示例

$value = apply_filters( "edit_user_{$field}", $value, $user_id );

注意事项

  • 钩子自 WordPress 2.9.0 版本引入,确保在兼容版本中使用。
  • 使用时需注意 $field 的动态性,正确指定字段名以避免错误。

📄 原文内容

Filters a user field value in the ‘edit’ context.

Description

The dynamic portion of the hook name, $field, refers to the prefixed user field being filtered, such as ‘user_login’, ‘user_email’, ‘first_name’, etc.

Parameters

$valuemixed
Value of the prefixed user field.
$user_idint
User ID.

Source

$value = apply_filters( "edit_user_{$field}", $value, $user_id );

Changelog

Version Description
2.9.0 Introduced.