add_user_meta()函数是Wordpress函数,向用户添加元数据。
add_user_meta( int $user_id, string $meta_key, mixed $meta_value, bool $unique = false )
参数(Parameters)
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
$user_id | (int) | 必需 | 用户ID。 |
$meta_key | (string) | 必需 | 元数据名称。 |
$meta_value | (mixed) | 必需 | 元数据值。 |
$unique | (bool) | 可选 | 是否不应添加相同的密钥。 |
返回(Return)
(int|false)Meta ID表示成功,false表示失败。
源码(Source)
/**
* Add meta data field to a user.
*
* Post meta data is called "Custom Fields" on the Administration Screens.
*
* @since 3.0.0
* @link https://codex.wordpress.org/Function_Reference/add_user_meta
*
* @param int $user_id User ID.
* @param string $meta_key Metadata name.
* @param mixed $meta_value Metadata value.
* @param bool $unique Optional, default is false. Whether the same key should not be added.
* @return int|false Meta ID on success, false on failure.
*/
function add_user_meta($user_id, $meta_key, $meta_value, $unique = false) {
return add_metadata('user', $user_id, $meta_key, $meta_value, $unique);
}
更新版本 | 源码位置 | 使用 | 被使用 |
---|---|---|---|
3.0.0 | wp-includes/user.php:793 | 1 function | 1 function |
笔记(Notes)
实例