delete_user_meta()
Удаляет указанные метаданные определенного пользователя.
Можно определять опцию для удаления по ключу ($meta_key) или одновременно по ключу и значению ключа ($meta_key, $meta_value). Удаление по ключу и значению оберегает от удаления дублирующих опций, у которых ключи одинаковые. А если указать только ключ, то будут удалены все опции с указанным ключом (их может быть несколько).
Метаданные пользователя - это аналог произвольных полей у постов. Только тут пост это пользователь. Сохраняются такие данные в таблицу wp_usermeta.
Работает на основе: delete_metadata()
Основа для: delete_user_option()
Хуков нет.
Возвращает
true|false. true или false, от успешного или не успешного удаления.
Использование
delete_user_meta( $user_id, $meta_key, $meta_value );
- $user_id(число) (обязательный)
- ID пользователя.
- $meta_key(строка) (обязательный)
- Название опции которую нужно удалить.
- $meta_value(строка)
- Значение опции, которую нужно удалить. Работает в связке с параметром $meta_key.
По умолчанию: ''
Примеры
#1 Удалим опцию _province у пользователя 9:
$user_id = 9;
if ( ! delete_user_meta($user_id, '_province') ) {
echo "Оооопс! Ошибочка случилась во время этой операции!";
}
Список изменений
| С версии 3.0.0 | Введена. |
Код delete_user_meta() delete user meta WP 6.7.2
function delete_user_meta( $user_id, $meta_key, $meta_value = '' ) {
return delete_metadata( 'user', $user_id, $meta_key, $meta_value );
}