delete_user_option() WP 3.0

Удаляет метаданные пользователя в масштабах сайта или сети сайтов.

Если не используете мультисайтовость, то вместо этой используйте функцию delete_user_meta().

Опции пользователя это тоже самое, что и метаданные пользователя. Разница в том, что для опций устанавливается префикс таблиц БД к метаданным, т.е. если у нас есть ключ username то для опции он будет выглядеть так: wp_username (где wp_ префикс таблиц текущего сайта).

Если параметр $global = false (так по умолчанию), то функция добавит префикс таблицы БД к названию метаполя.

Хуков нет.

Возвращает

true при успешном удалении и false если удалить не получилось.

Использование

delete_user_option( $user_id, $option_name, $global );

$user_id(число) (обязательный)

ID пользователя.
По умолчанию: нет

$option_name(строка) (обязательный)

Название опции.
По умолчанию: нет

$global(логический)

Является ли опция глобальной (в сети сайтов) или она относится только к одному блогу. По умолчанию false - относится к текущему блогу.
По умолчанию: false

Примеры

#1. Удалим метаданные default_password_nag у пользователя с ID=8:

if( delete_user_option( 9, 'default_password_nag' ) )
	echo "опция default_password_nag удалена!";
else
	echo "не удалось удалить опцию default_password_nag!";

Заметки

• Global. wpdb. $wpdb WordPress database abstraction object.

Список изменений

Код delete user option: wp-includes/user.php ^{WP 5.2.2}

<?php
function delete_user_option( $user_id, $option_name, $global = false ) {
	global $wpdb;

	if ( ! $global ) {
		$option_name = $wpdb->get_blog_prefix() . $option_name;
	}
	return delete_user_meta( $user_id, $option_name );
}

Cвязанные функции

Из метки: Пользователи (_user)

Еще из раздела: Юзеры в Мультисайт