WordPress插入用户函数:wp_insert_user
WordPress函数wp_insert_user用于插入用户。
wp_insert_user( array|object|WP_User $userdata )
函数参数
$userdata
数组或WP_User对象
wp_insert_user()函数$args参数默认值如下:
- ID:如果提供ID,则更新现有用户数据;
- user_pass:用户密码;
- user_login:用户登录名;
- user_nicename:URL友好的用户名;
- user_url:用户站点地址;
- user_email:用户邮箱;
- display_name:用户公开显示名称;
- nickname:用户的昵称;
- first_name:名字;
- last_name:姓氏;
- description:用户简介;
- rich_editing:是否为用户启用富编辑器,接受“true”或“false”字符串值,而不是布尔值,默认值为“true”;
- syntax_highlighting:是否为用户启用富代码编辑器,接受“true”或“false”字符串值,而不是布尔值,默认值为“true”;
- comment_shortcuts:是否为用户启用评论调节键盘快捷键,接受“true”或“false”字符串值,而不是布尔值,默认值为“false”;
- admin_color:后台配色方案,默认值:fresh;
- use_ssl:用户是否应始终使用https访问后台,默认值:false;
- user_registered:用户的注册日期;
- user_activation_key:找回密码的Key;
- spam:多站点时可启用,将用户标记为垃圾邮件;
- show_admin_bar_front:是否在网站前端为用户显示管理栏,接受“true”或“false”字符串值,而不是布尔值,默认值为“true”;
- role:设置用户角色权限;
- locale:用户的区域设置;
- meta_input:数组键值对,设置用户的元数据。
函数返回值
成功时返回用户ID,失败返回WP_Error对象。
函数使用示例
$data = array(
'user_login' => 'test',
'user_pass' => '123456',
'show_admin_bar_front' => false
);
$user_id = wp_insert_user($data);
if(!is_wp_error($user_id)) {
echo "用户ID : " . $user_id;
}
扩展阅读
wp_insert_user()函数位于:wp-includes/user.php
相关函数:
- insert_custom_user_meta()
- wp_pre_insert_user_data()
- insert_user_meta()
- edit_user()
- wp_update_user()
- wp_create_user()