方法描述
更新指定用户ID的配置属性。
用$prev_value
参数来区别拥有相同键值和用户ID的配置属性。
如果要更新的配置属性对于某个用户不存在,那就会新增这个配置属性。
使用方法
<?php update_user_meta( $user_id, $meta_key, $meta_value, $prev_value ); ?>
参数
$user_id
(integer
) (required
) 用户ID。
默认:None
$meta_key
(string
) (required
) 要更新的wp_usermeta
表中存储的配置属性键名称。
默认: None
$meta_value
(mixed
) (required
) 将要更新的新的配置属性值,必须与现有的不一样。Array
和Objects
都会被自动序列化。注意使用对象可能会导致报错。
默认: None
$prev_value
(mixed
) (optional
) 要检查的之前的属性值。
默认: ''
返回值
(int
/boolean
)
如果要更新的配置属性不存在,那么返回新创建的配置属性ID,更新成功返回true
,更新失败返回false
。
示例
下面这个例子示范如何更新用户的站点属性
<?php
$user_id = 1;
$website = 'http://wordpress.org';
update_user_meta($user_id, 'user_url', $website);
?>
下面这个例子示范如何检测错误:
$user_id = 1;
$new_value = 'some new value';
// will return false if the previous value is the same as $new_value
update_user_meta( $user_id, 'some_meta_key', $new_value );
// so check and make sure the stored value matches $new_value
if ( get_user_meta($user_id, 'some_meta_key', true ) != $new_value )
wp_die('An error occurred');
?>
注意
使用: update_metadata()
同update_usermeta
功能上有所变化,不过这个方法已经弃用了:
- 如果新的要更新的值为空,
update_user_meta
不会删除这个配置属性 - 具体操作有所不同
源文件
update_user_meta()
在这wp-includes/user.php.
相关
add_user_meta(), delete_user_meta(), get_user_meta(), update_user_meta(), get_user_option(), delete_user_option(), update_user_option(),