get_user_option() — описание функции WordPress на русском

Сигнатура

get_user_option( string $option, int $user, string $deprecated = '' ): mixed

Описание

Если ID пользователя не указан, вместо него используется текущий пользователь. Если ID пользователя указан, извлекаются данные этого пользователя. Фильтр результата также передаёт исходное имя опции и, наконец, объект данных пользователя в качестве третьего параметра.
Опция сначала проверяется по имени на уровне сайта, затем по имени на уровне сети.

Оригинал (английский)

If the user ID is not given, then the current user will be used instead. If the user ID is given, then the user data will be retrieved. The filter for the result, will also pass the original option name and finally the user data object as the third parameter.

The option will first check for the per site name and then the per Network name.

Параметры

$option string обязательный

Имя пользовательской опции.

$user int необязательный

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

$deprecated string необязательный = ''

Используйте get_option() для проверки опции в таблице опций.

Возвращаемое значение

mixed

Исходный код

wp-includes/user.php:753

function get_user_option( $option, $user = 0, $deprecated = '' ) {
	global $wpdb;

	if ( ! empty( $deprecated ) ) {
		_deprecated_argument( __FUNCTION__, '3.0.0' );
	}

	if ( empty( $user ) ) {
		$user = get_current_user_id();
	}

	$user = get_userdata( $user );
	if ( ! $user ) {
		return false;
	}

	$prefix = $wpdb->get_blog_prefix();
	if ( $user->has_prop( $prefix . $option ) ) { // Blog-specific.
		$result = $user->get( $prefix . $option );
	} elseif ( $user->has_prop( $option ) ) { // User-specific and cross-blog.
		$result = $user->get( $option );
	} else {
		$result = false;
	}

	/**
	 * Filters a specific user option value.
	 *
	 * The dynamic portion of the hook name, `$option`, refers to the user option name.
	 *
	 * @since 2.5.0
	 *
	 * @param mixed   $result Value for the user's option.
	 * @param string  $option Name of the option being retrieved.
	 * @param WP_User $user   WP_User object of the user whose option is being retrieved.
	 */
	return apply_filters( "get_user_option_{$option}", $result, $option, $user );
}

История изменений

Версия	Описание
2.0.0	Introduced.