{"id":11086,"date":"2014-09-24T19:19:54","date_gmt":"2014-09-24T19:19:54","guid":{"rendered":"http:\/\/developer.wordpress.org\/?post_type=plugin-handbook&p=11086"},"modified":"2022-11-17T06:08:51","modified_gmt":"2022-11-17T06:08:51","slug":"working-with-users","status":"publish","type":"plugin-handbook","link":"https:\/\/developer.wordpress.org\/plugins\/users\/working-with-users\/","title":{"rendered":"Working with Users"},"content":{"rendered":"\n

Adding Users<\/h2>\n\n\n\n

To add a user you can use wp_create_user()<\/code> or wp_insert_user()<\/code>.<\/p>\n\n\n\n

wp_create_user()<\/code> creates a user using only the username, password and email parameters while wp_insert_user()<\/code> accepts an array or object describing the user and its properties.<\/p>\n\n\n\n

Create User<\/h3>\n\n\n\n

wp_create_user()<\/code> allows you to create a new WordPress user.<\/p>\n\n\n\n

\n
<\/div>\n

\nIt uses wp_slash()<\/a> to escape the values. The PHP compact() function to create an array with these values. The wp_insert_user()<\/a> to perform the insert operation.
\n<\/div><\/div>\n\n\n\n\n

Please refer to the Function Reference about wp_create_user()<\/code> for full explanation about the used parameters.<\/p>\n\n\n\n

Example Create<\/h4>\n\n\n\n
\/\/ check if the username is taken\n$user_id = username_exists( $user_name );\n\n\/\/ check that the email address does not belong to a registered user\nif ( ! $user_id && email_exists( $user_email ) === false ) {\n\t\/\/ create a random password\n\t$random_password = wp_generate_password( 12, false );\n\t\/\/ create the user\n\t$user_id = wp_create_user(\n\t\t$user_name,\n\t\t$random_password,\n\t\t$user_email\n\t);\n}<\/code><\/pre>\n\n\n\n
Insert User<\/h3>\n\n\n\n
wp_insert_user( $userdata );<\/code><\/pre>\n\n\n\n
\n
<\/div>\n

\nThe function calls a filter for most predefined properties.<\/p>\n
The function performs the action user_register<\/code> when creating a user (user ID does not exist).<\/p>\n
The function performs the action profile_update<\/code> when updating the user (user ID exists).
\n<\/div><\/div>\n\n\n\n\n
Please refer to the Function Reference about wp_insert_user()<\/code> for full explanation about the used parameters.<\/p>\n\n\n\n
Example Insert<\/h4>\n\n\n\n
Below is an example showing how to insert a new user with the website profile field filled in.<\/p>\n\n\n\n
$username  = $_POST['username'];\n$password  = $_POST['password'];\n$website   = $_POST['website'];\n$user_data = [\n\t'user_login' => $username,\n\t'user_pass'  => $password,\n\t'user_url'   => $website,\n];\n\n$user_id = wp_insert_user( $user_data );\n\n\/\/ success\nif ( ! is_wp_error( $user_id ) ) {\n\techo 'User created: ' . $user_id;\n}<\/code><\/pre>\n\n\n\n
Updating Users<\/h2>\n\n\n\n
wp_update_user()<\/code> Updates a single user in the database. The update data is passed along in the $userdata<\/code> array\/object.<\/p>\n\n\n\n
To update a single piece of user meta data, use update_user_meta()<\/code> instead. To create a new user, use wp_insert_user()<\/code> instead.<\/p>\n\n\n\n
\n
<\/div>\n

\nIf current user’s password is being updated, then the cookies will be cleared!
\n<\/div><\/div>\n\n\n\n\n
Please refer to the Function Reference about wp_update_user()<\/code> for full explanation about the used parameters.<\/p>\n\n\n\n
Example Update<\/h4>\n\n\n\n
Below is an example showing how to update a user’s website profile field.<\/p>\n\n\n\n
$user_id = 1;\n$website = 'https:\/\/wordpress.org';\n\n$user_id = wp_update_user(\n\tarray(\n\t\t'ID'       => $user_id,\n\t\t'user_url' => $website,\n\t)\n);\n\nif ( is_wp_error( $user_id ) ) {\n\t\/\/ error\n} else {\n\t\/\/ success\n}<\/code><\/pre>\n\n\n\n
Deleting Users<\/h2>\n\n\n\n
wp_delete_user()<\/code> deletes the user and optionally reassign associated entities to another user ID.<\/p>\n\n\n\n
\n
<\/div>\n

\nThe function performs the action deleted_user<\/code> after the user have been deleted.
\n<\/div><\/div>\n\n\n\n\n
\n
<\/div>\n

\nIf the $reassign parameter is not set to a valid user ID, then all entities belonging to the deleted user will be deleted!
\n<\/div><\/div>\n\n\n\n\n
Please refer to the Function Reference about wp_delete_user()<\/code> for full explanation about the used parameters.<\/p>\n","protected":false},"author":12560283,"featured_media":0,"parent":11084,"menu_order":0,"template":"","meta":{"footnotes":""},"class_list":["post-11086","plugin-handbook","type-plugin-handbook","status-publish","hentry","type-handbook"],"revision_note":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/plugin-handbook\/11086","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/plugin-handbook"}],"about":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/types\/plugin-handbook"}],"author":[{"embeddable":true,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/users\/12560283"}],"version-history":[{"count":62,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/plugin-handbook\/11086\/revisions"}],"predecessor-version":[{"id":144325,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/plugin-handbook\/11086\/revisions\/144325"}],"up":[{"embeddable":true,"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/plugin-handbook\/11084"}],"wp:attachment":[{"href":"https:\/\/developer.wordpress.org\/wp-json\/wp\/v2\/media?parent=11086"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}