функция
since 3.0.0
update_user_meta()
Проверено на WordPress 6.9, обновлено Источник: WordPress Developer Resources.
Сигнатура
update_user_meta( int $user_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' ): int|boolОписание
Используйте параметр $prev_value, чтобы различать поля метаданных с одинаковыми ключом и ID пользователя.
Если поле метаданных для пользователя не существует, оно будет добавлено.
По историческим причинам и ключ, и значение метаданных на входе должны быть экранированы обратными слешами.
Оригинал (английский)
Use the $prev_value parameter to differentiate between meta fields with the same key and user ID.
If the meta field for the user does not exist, it will be added.
For historical reasons both the meta key and the meta value are expected to be “slashed” (slashes escaped) on input.
Параметры
$user_id
int
обязательный
ID пользователя.
$meta_key
string
обязательный
Ключ метаданных.
$meta_value
mixed
обязательный
Значение метаданных. Должно быть сериализуемым, если не является скалярным значением.
$prev_value
mixed
необязательный
= ''
Предыдущее значение для проверки перед обновлением.
Если указано, обновляются только существующие записи метаданных с этим значением. В противном случае обновляются все записи.
Возвращаемое значение
int|bool
Исходный код
wp-includes/user.php:1309
function update_user_meta( $user_id, $meta_key, $meta_value, $prev_value = '' ) {
return update_metadata( 'user', $user_id, $meta_key, $meta_value, $prev_value );
}История изменений
| Версия | Описание |
|---|---|
| 3.0.0 | Introduced. |
