update_user_meta()函数用于更新WordPress用户的元数据。元数据是指与用户相关的任何额外信息,例如姓名、年龄、电话号码等。
以下是update_user_meta()函数的详细用法:
1. 语法:
update_user_meta( $user_id, $meta_key, $meta_value, $prev_value );
- $user_id:必需,要更新元数据的用户ID。
- $meta_key:必需,要更新的元数据的键名。
- $meta_value:必需,要更新的元数据的新值。
- $prev_value:可选,要更新的元数据的旧值。如果指定了该参数,并且旧值与指定的值匹配,才会进行更新。
2. 示例:
update_user_meta( 123, 'phone_number', '555-1234' );
该示例将用户ID为123的用户的"phone_number"元数据更新为"555-1234"。
3. 注意事项:
- update_user_meta()函数会自动添加元数据,如果元数据不存在,则会创建一个新的元数据。
- 如果元数据已经存在,并且新值与旧值相同,那么不会进行更新。
- 如果元数据已经存在,并且需要删除该元数据,可以将$meta_value参数设置为空字符串或null,或者使用delete_user_meta()函数。
- update_user_meta()函数返回更新后的元数据的新值,如果更新失败,则返回false。
例如:
$updated_value = update_user_meta( 123, 'phone_number', '555-1234' );
if ( $updated_value !== false ) {
echo '元数据已成功更新:' . $updated_value;
} else {
echo '元数据更新失败';
}
在上述示例中,如果元数据更新成功,将输出"元数据已成功更新:555-1234",否则将输出"元数据更新失败"。
以上是update_user_meta()函数的详细用法。根据需要,您可以使用该函数来更新WordPress用户的元数据。
0 个评论