wp_update_user() │ WP 2.0.0
Оновлює дані користувача у базі даних. Оновлюються обидві таблиці wp_usermeta та wp_users.
Якщо оновлюється пароль поточного користувача, він буде пропущений через функцію wp_hash_password() , а куки будуть скинуті.
Щоб створити нового користувача, використовуйте функції register_new_user() .
Створити користувача за допомогою цієї функції стало неможливо за версією WP 3.6.
Повертає
int|WP_Error
. ID користувача або об’єкт WP_Error.
Використання
wp_update_user($userdata);
-
$userdata
(масив/об’єкт/WP_User) -
Масив даних, які потрібно оновити.
За замовчуванням дані користувача.
Приклади
#1 Оновимо поле: website у користувача 1:
$user_id = 1;
$website = 'http://wordpress.org';
$user_id = wp_update_user([
'ID' => $user_id,
'user_url' => $website
]);
if ( is_wp_error( $user_id ) ) {
// Відбулася помилка, можливо, такого користувача не існує.
}
else {
// Все ОК!
}
Ця функція не може оновити логін (username), так само як ми не можемо його змінити з адмін-панелі.
Базові поля, які можна оновити:
$userdata = [
'ID' => 1,
'user_pass' => '',
'user_nicename' => '',
'user_url' => '',
'user_email' => '',
'display_name' => '',
'nickname' => '',
'first_name' => '',
'last_name' => '',
'description' => '',
'rich_editing' => true, // false – вимкнути візуальний редактор для користувача.
'user_registered' => '', // дата реєстрації (Ymd H:i:s)
'role' => '', // (рядок) роль користувача
];
#2 Відновимо інформацію у певних користувачів
Отримаємо користувачів з роллю project_manager та оновимо у них поле “Відображати як” на основі імені та прізвища, якщо зазначені.
$ users = get_users ([
'role' => 'project_manager',
]);
foreach ( $users as $user ) {
$fio = trim( "$user->first_name $user->last_name");
if ( $fio ) {
$user->data->display_name = $fio;
wp_update_user($user);
}
}
нотатки
список змін
Код wp_update_user() wp update user WP 6.0.2
function wp_update_user( $userdata ) {
if ( $userdata instanceof stdClass ) {
$ userdata = get_object_vars ($ userdata);
} elseif ( $userdata instanceof WP_User ) {
$userdata = $userdata->to_array();
}
$user_id = isset( $userdata['ID'] ) ? (int) $userdata['ID'] : 0;
if ( ! $user_id ) {
return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
}
// First, get all of the original fields.
$ user_obj = get_userdata ($ user_id);
if ( ! $user_obj ) {
return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
}
$user = $user_obj->to_array();
/ / Add additional custom fields.
foreach ( _get_additional_user_keys( $user_obj ) as $key ) {
$user[$key] = get_user_meta($user_id, $key, true);
}
// Escape data pulled from DB.
$ user = add_magic_quotes ($ user);
if ( ! empty( $userdata['user_pass'] ) && $userdata['user_pass'] !== $user_obj->user_pass ) {
// If password is changing, hash it now.
$plaintext_pass = $userdata['user_pass'];
$userdata['user_pass'] = wp_hash_password( $userdata['user_pass'] );
/**
* Filters whether to send the password change email.
*
* @ Since 4.3.0
*
* @see wp_insert_user() For `$user` та `$userdata` fields.
*
* @param bool $send Whether to send the email.
* @param array $user Оригінальний user array.
* @param array $userdata Update user array.
*/
$send_password_change_email = apply_filters( 'send_password_change_email', true, $user, $userdata );
}
if ( isset( $userdata['user_email'] ) && $user['user_email'] !== $userdata['user_email'] ) {
/**
* Filters whether to send the email change email.
*
* @ Since 4.3.0
*
* @see wp_insert_user() For `$user` та `$userdata` fields.
*
* @param bool $send Whether to send the email.
* @param array $user Оригінальний user array.
* @param array $userdata Update user array.
*/
$send_email_change_email = apply_filters( 'send_email_change_email', true, $user, $userdata );
}
clean_user_cache($user_obj);
// Merge old and new fields with new fields overwriting old ones.
$userdata = array_merge($user, $userdata);
$user_id = wp_insert_user($userdata);
if ( is_wp_error( $user_id ) ) {
return $user_id;
}
$blog_name = wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
$ switched_locale = false;
if ( ! empty( $send_password_change_email ) || ! empty( $send_email_change_email ) ) {
$ switched_locale = switch_to_locale (get_user_locale ($ user_id));
}
if ( ! empty( $send_password_change_email ) ) {
/* translators: Недоступний USERNAME, ADMIN_EMAIL, EMAIL, SITENAME, SITEURL: є placeholders. */
$pass_change_text = __(
'Hi ###USERNAME###,
Це твердження, що ваше слово було змінено на ###SITENAME###.
Якщо ви не збираєтесь змінити свій password, скористайтесь contact the Site Administrator at
###ADMIN_EMAIL###
Цей email буде been sent to ###EMAIL###
Regards,
All at ###SITENAME###
###SITEURL###'
);
$pass_change_email = array(
'to' => $user['user_email'],
/* translators: Password change notification email subject. %s: Site title. */
'subject' => __( '[%s] Password Changed' ),
'message' => $pass_change_text,
'headers' => '',
);
/**
* Filters the contents of the email sent when the user's password is changed.
*
* @ Since 4.3.0
*
* @param array $pass_change_email {
* Used to build wp_mail().
*
* @type string $to The intended recipients. Add emails in a comma separated string.
* @type string $subject Subject of the email.
* @type string $message content of the email.
* The following strings має особливу техніку і буде отримувати динамічно:
* - ###USERNAME### The current user's username.
* - ###ADMIN_EMAIL### The admin email в разі цього було невиявлено.
* - ###EMAIL### The user's email address.
* - ###SITENAME### The name of the site.
* - ###SITEURL### The URL to the site.
* @type string $headers Headers. Add headers in a newline (rn) separated string.
* }
* @param array $user Оригінальний user array.
* @param array $userdata Update user array.
*/
$pass_change_email = apply_filters( 'password_change_email', $pass_change_email, $user, $userdata);
$pass_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $pass_change_email['message'] );
$pass_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $pass_change_email['message'] );
$pass_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $pass_change_email['message'] );
$pass_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $pass_change_email['message'] );
$pass_change_email['message'] = str_replace( '###SITEURL###', home_url(), $pass_change_email['message'] );
wp_mail( $pass_change_email['to'], sprintf( $pass_change_email['subject'], $blog_name ), $pass_change_email['message'], $pass_change_email['headers'] );
}
if ( ! empty( $send_email_change_email ) ) {
/* translators: Недоступний USERNAME, ADMIN_EMAIL, NEW_EMAIL, EMAIL, SITENAME, SITEURL: є placeholders. */
$email_change_text = __(
'Hi ###USERNAME###,
Це означає, що ваші адреси електронної пошти на ###SITENAME### changed to ###NEW_EMAIL###.
Якщо ви не збираєтесь змінити свій e-mail, скористайтесь contact the Site Administrator at
###ADMIN_EMAIL###
Цей email буде been sent to ###EMAIL###
Regards,
All at ###SITENAME###
###SITEURL###'
);
$email_change_email = array(
'to' => $user['user_email'],
/* translators: Email change notification email subject. %s: Site title. */
'subject' => __( '[%s] Email Changed' ),
'message' => $email_change_text,
'headers' => '',
);
/**
* Filters contents the email email when the user's email is changed.
*
* @ Since 4.3.0
*
* @param array $email_change_email {
* Used to build wp_mail().
*
* @type string $to The intended recipients.
* @type string $subject Subject of the email.
* @type string $message content of the email.
* The following strings має особливу техніку і буде отримувати динамічно:
* - ###USERNAME### The current user's username.
* - ###ADMIN_EMAIL### The admin email в разі цього було невиявлено.
* - ###NEW_EMAIL### The new email address.
* - ###EMAIL### The old email address.
* - ###SITENAME### The name of the site.
* - ###SITEURL### The URL to the site.
* @type string $headers Headers.
* }
* @param array $user Оригінальний user array.
* @param array $userdata Update user array.
*/
$email_change_email = apply_filters( 'email_change_email', $email_change_email, $user, $userdata);
$email_change_email['message'] = str_replace( '###USERNAME###', $user['user_login'], $email_change_email['message'] );
$email_change_email['message'] = str_replace( '###ADMIN_EMAIL###', get_option( 'admin_email' ), $email_change_email['message'] );
$email_change_email['message'] = str_replace( '###NEW_EMAIL###', $userdata['user_email'], $email_change_email['message'] );
$email_change_email['message'] = str_replace( '###EMAIL###', $user['user_email'], $email_change_email['message'] );
$email_change_email['message'] = str_replace( '###SITENAME###', $blog_name, $email_change_email['message'] );
$email_change_email['message'] = str_replace( '###SITEURL###', home_url(), $email_change_email['message'] );
wp_mail( $email_change_email['to'], sprintf( $email_change_email['subject'], $blog_name ), $email_change_email['message'], $email_change_email['headers'] );
}
if ($ switched_locale) {
restore_previous_locale();
}
// Update the cookies if the password changed.
$current_user = wp_get_current_user();
if ( $current_user->ID == $user_id ) {
if ( isset ( $ plaintext_pass ) ) {
wp_clear_auth_cookie();
// Тут ми виміряли expiration ength of the current auth cookie and compare it to default expiration.
// If it's greater than this, then we know the user checked 'Remember Me' when they logged in.
$logged_in_cookie = wp_parse_auth_cookie( '', 'logged_in' );
/** Цей filter is documented в wp-includes/pluggable.php */
$default_cookie_life = apply_filters( 'auth_cookie_expiration', ( 2 * DAY_IN_SECONDS ), $user_id, false );
$remember = false;
if ( false !== $logged_in_cookie && ( $logged_in_cookie['expiration'] - time() ) > $default_cookie_life ) {
$remember = true;
}
wp_set_auth_cookie($user_id, $remember);
}
}
return $user_id;
}
Зв’язані функції