update_user_option() WP 2.0.0

Обновляет опцию (метаполе) пользователя. Рассчитана на MU режим. Похожа на update_user_meta(), только добавляет префикс БД к названию опции (метаполя).

Принцип работы:

Если $global = false (по умолчанию), добавляет к названию метаполя префикс базы данных (из wp-config.php).
Если $global = true, полностью идентична update_user_meta().

Работает на основе: update_user_meta()

Хуков нет.

Возвращает

Число/true/false.

ID метаполя, если оно не существовало ранее и было создано
true при успешном обновлении значения
false при ошибке.

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

update_user_option( $user_id, $option_name, $newvalue, $global );

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

ID Пользователя.

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

Название опции.

$newvalue(смешанный) (обязательный)

Значение опции.

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

Определяет является ли опция глобальной или относится к локальному сайту.

При $global=true полностью идентична update_user_meta().
По умолчанию: false

Примеры

#1 Добавляем опцию `префикс_test_option` для пользователя с ID 1

update_user_option( 1, 'test_option', 'my_value' );
// у юзера 1 появится метаполе wp_test_option со значением my_value
// wp_ тут - это префикс базы данных

#2 Добавляем опцию `test_option` для пользователя с ID 1

update_user_option( 1, 'test_option',  'my_value', true );
// аналог update_user_meta() - у юзера 1 появится 
// метаполе test_option со значением my_value

Заметки

Global. wpdb. $wpdb WordPress database abstraction object.

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

С версии 2.0.0

Введена.

Код update user option: `wp-includes/user.php` ^{WP 5.4.2}

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

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

	return update_user_meta( $user_id, $option_name, $newvalue );
}