get_user_meta() WP 3.0

Получает отдельное мета поле или все мета поля указанного пользователя.

Хуков нет.

Возвращает

• Значение мета поля, если параметр $single = true.
• Массив, если $key не был указан или $single = false.
• Если мета поля не существует и $single = true, функция вернет пустую строку. Если $single = false будет возвращен пустой массив.

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

get_user_meta( $user_id, $key, $single );

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

ID пользователя, данные которого нужно получить.

$key(строка)

Ключ мета поля, данные которого нужно получить. Если оставить этот параметр пустым, то будут возвращены все мета поля пользователя.
По умолчанию: ''

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

Если установить в true, то функция вернет значение мета поля, если оставить false, то значение мета поля будет возращено в массиве. Этот параметр не имеет смысла, если параметр $key не был указан.
По умолчанию: false

Примеры

#1 Пример использования

Этот пример получит и затем выведет на экран Ник пользователя с ID = 9:

$user_id = 9;
$key = 'nickname';
$single = true;
$user_last = get_user_meta( $user_id, $key, true ); 
echo 'Значение ключа '. $key . ' у пользователя ' . $user_id . ' равно: ' . $user_last; 

// получим:
// Значение ключа nickname у пользователя 9 равно: Enot

#2 Получение всех метаданных

Этот пример показывает что будет если $key оставить пустым, чтобы получить все метаданных указанного пользователя:

$all_meta_for_user = get_user_meta( 9 );

/* 
$all_meta_for_user будет содержать массив:
Array ( 
	[first_name] => Array ( [0] => Tom ) 
	[last_name] => Array ( [0] => Auger) 
	[nickname] => Array ( [0] => tomauger ) 
	[description] => и т.д... 
)
*/

Чтобы получить данные из этого примера, вам нужно получать первый элемент массива, так:

$last_name = $all_meta_for_user['last_name'][0];

Чтобы избежать этого неудобства, возможно лучше применить свою функцию к получаемому массиву, используя array_map():

$all_meta_for_user = array_map( function( $a ){ return $a[0]; }, get_user_meta( $user_id ) );

/*
Теперь, $all_meta_for_user будет содержать такой массив:

Array ( 
	[first_name] => Tom 
	[last_name] => Auger 
	[nickname] => tomauger 
	[description] => и т.д...
)
*/

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

Код get user meta: wp-includes/user.php ^{WP 5.3.1}

<?php
function get_user_meta( $user_id, $key = '', $single = false ) {
	return get_metadata( 'user', $user_id, $key, $single );
}

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

Из метки: metadata (метаданные)