Функция get_user_meta(): Полное руководство с примерами

Функция get_user_meta() в WordPress используется для получения метаданных, связанных с пользователем. Эти метаданные хранятся в таблице wp_usermeta (название таблицы может изменяться в зависимости от префикса базы данных) и представляют собой дополнительные параметры пользователя, такие как first_name (имя), last_name (фамилия), или любые другие пользовательские поля, добавленные вручную или при помощи плагинов.

Синтаксис

mixed get_user_meta( int $user_id, string $key = '', bool $single = false )

Параметры

• $user_id (int) (обязательный): ID пользователя, метаданные которого нужно получить.
• $key (string) (необязательный): Ключ метаданных. Если указан, функция вернет значение метаданных для этого ключа. Если не указан, вернется массив всех метаданных для данного пользователя.
• $single (bool) (необязательный): Если true, функция вернет только одно значение метаданных (первое найденное). Если false, вернется массив всех значений для данного ключа. По умолчанию false.

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

• false: В случае, если указан неверный $user_id или пользователя с указанным ID не существует.
• строка или массив: Если $single равно true, функция вернет значение метаданных для указанного ключа. Значения метаполей хранятся в виде строк, но могут быть возвращены как массив, если они были сериализованы.
• массив: Если $single равно false, функция вернет массив всех значений для указанного ключа. Даже если существует только одно значение, оно будет возвращено в виде массива.
• » (пустая строка): Если $single равно true и метаполя с указанным ключом не существует.
• array() (пустой массив): Если $single равно false и метаполя с указанным ключом не существует.

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

Рассмотрим несколько примеров использования функции get_user_meta() для более глубокого понимания.

Простой пример: получение одного значения метаданных

Выведем имя пользователя с ID = 5:

$user_id = 5;
$meta_key = 'first_name';

// Получаем значение метаданных
$meta_value = get_user_meta($user_id, $meta_key, true);

if (!empty($meta_value)) {
    echo 'Имя пользователя: ' . $meta_value;
} else {
    echo 'Метаданные для указанного ключа не найдены.';
}

Получение всех значений для указанного ключа

Получим все значения метаданных для ключа favorite_color:

$user_id = 123;
$meta_key = 'favorite_color';

// Получаем все значения метаданных для указанного ключа
$meta_values = get_user_meta($user_id, $meta_key, false);

if (!empty($meta_values)) {
    echo 'Любимые цвета пользователя: <br>';
    foreach ($meta_values as $value) {
        echo '- ' . $value . '<br>';
    }
} else {
    echo 'Метаданные для указанного ключа не найдены.';
}

Получение всех метаданных для пользователя

Получим все метаданные для пользователя с ID = 5 и выведем имя пользователя из полученного результата:

$user_id = 5;

// Получаем все метаданные для пользователя
$all_user_params = get_user_meta($user_id);

if (!empty($all_user_params)) {
    echo 'Все метаданные для пользователя: <br>';
    foreach ($all_user_params as $key => $values) {
        echo '<strong>' . $key . ':</strong><br>';
        foreach ($values as $value) {
            echo '- ' . $value . '<br>';
        }
    }
    echo 'Имя пользователя: ' . $all_user_params['first_name'][0];
} else {
    echo 'Метаданные для пользователя не найдены.';
}

Заключение

Функция get_user_meta() является мощным инструментом для работы с метаданными пользователей в WordPress. Она позволяет легко получать дополнительные данные, связанные с пользователями, что значительно расширяет функциональность вашего сайта. Понимание и правильное использование get_user_meta() поможет вам создавать более сложные и функциональные WordPress-сайты, удовлетворяющие самые разнообразные требования.

Эта функция важна для разработчиков, которые хотят хранить и извлекать пользовательские данные, не ограничиваясь стандартными полями профиля пользователя.