get_avatar()

Извлекает тег аватара для пользователя, адреса электронной почты, MD5-хэша, комментария или записи
Функция WordPress
INT 2.5.0
WordPress Icon
Содержание
  1. Описание функции
  2. Примеры использования
  3. Получение аватара пользователя по ID
  4. Отображение аватара пользователя по email
  5. Использование MD5-хэша для получения аватара
  6. Получение аватара пользователя по комментарию
  7. Получение аватара пользователя по записи
  8. Вопросы и ответы
  9. Как изменить размер аватарки, возвращаемой функцией get_avatar()?
  10. Как задать пользовательское изображение по умолчанию для аватарки?
  11. Как изменить альтернативный текст для аватарки?
  12. Как изменить классы CSS для тега аватарки?
  13. Как всегда показывать изображение по умолчанию, а не Gravatar?
  14. Как изменить рейтинг аватарок, отображаемых функцией get_avatar()?
  15. Функция get_avatar()
  16. Как изменить URL-схему для аватарки?
  17. Как всегда показывать аватарку, игнорируя настройки отображения аватаров?
  18. Как добавить дополнительные атрибуты HTML для тега <img> аватарки?
  19. Связанные элементы

Описание функции

Функция get_avatar() возвращает тег <img> с аватаром пользователя, основываясь на переданных параметрах. Аватар может быть получен по идентификатору пользователя, email адресу, MD5 хешу, комментарию или записи.

Функция использует сервис Gravatar для получения аватаров. Если аватар не найден, то функция может вернуть изображение по умолчанию.

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

get_avatar( mixed $id_or_email, int $size = 96, string $default_value = '', string $alt = '', array $args = null ): string|false

Функция get_avatar() принимает следующие параметры:

  • $id_or_email (mixed, обязательный): Идентификатор пользователя, MD5 хеш, email адрес, объект WP_User, объект WP_Post или объект WP_Comment, для которого нужно получить аватар.
  • $size (int, необязательный): Высота и ширина изображения аватара в пикселях. По умолчанию: 96.
  • $default_value (string, необязательный): URL изображения по умолчанию или тип изображения по умолчанию. Принимает значения ‘404’ (возвращает 404 вместо изображения по умолчанию), ‘retro’ (8-битное изображение), ‘RoboHash’ (робохэш), ‘monsterid’ (монстр), ‘wavatar’ (мультяшное лицо), ‘indenticon’ (квилт), ‘mystery’, ‘mm’ или ‘mysteryman’ (человек-устрица), ‘blank’ (прозрачный GIF) или ‘gravatar_default’ (логотип Gravatar). По умолчанию используется значение опции ‘avatar_default’, с откатом к ‘mystery’ в случае отсутствия значения.
  • $alt (string, необязательный): Альтернативный текст для использования в теге <img>. По умолчанию: ».
  • $args (array, необязательный): Дополнительные аргументы для получения аватара. Возможные параметры:
    • height (int): Высота аватара в пикселях. По умолчанию равна значению параметра $size.
    • width (int): Ширина аватара в пикселях. По умолчанию равна значению параметра $size.
    • force_default (bool): Всегда показывать изображение по умолчанию, а не аватар Gravatar. По умолчанию: false.
    • rating (string): Какие рейтинги аватаров отображать. Принимает значения ‘G’, ‘PG’, ‘R’, ‘X’ и оцениваются в этом порядке. По умолчанию используется значение опции ‘avatar_rating’.
    • scheme (string): Схема URL для использования. См. функцию set_url_scheme() для принимаемых значений.
    • class (array|string): Дополнительные классы для добавления к элементу <img>.
    • force_display (bool): Всегда показывать аватар, игнорируя опцию ‘show_avatars’. По умолчанию: false.
    • loading (string): Значение для атрибута loading. По умолчанию: null.
    • extra_attr (string): HTML атрибуты для вставки в элемент <img>. Не проходят санитизацию. По умолчанию: пусто.

Функция возвращает строку с тегом <img> для аватара пользователя. В случае ошибки возвращает false.

<?php
/**
 * Выводит аватар пользователя с помощью функции get_avatar().
 *
 * @param int $user_id Идентификатор пользователя.
 */
function display_user_avatar( $user_id ) {
    $avatar = get_avatar( $user_id, 96, '', 'User Avatar', array(
        'class' => 'avatar',
        'force_default' => true,
        'rating' => 'G',
        'scheme' => 'https',
        'force_display' => false,
        'loading' => 'lazy',
        'extra_attr' => 'data-id="123"',
    ) );
    echo $avatar;
}
?>

В этом примере мы создаем функцию display_user_avatar(), которая выводит аватар пользователя с использованием функции get_avatar(). Мы передаем идентификатор пользователя, размер аватара, пустое значение по умолчанию, альтернативный текст, а также массив с дополнительными аргументами.

В данном случае мы указываем класс «avatar» для элемента <img>, принудительно используем изображение по умолчанию, ограничиваем рейтинг аватаров значением «G», используем схему «https», игнорируем опцию «show_avatars», добавляем атрибут «loading» со значением «lazy» и вставляем дополнительный атрибут «data-id» со значением «123».

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

Получение аватара пользователя по ID


$user_id = 123; // ID пользователя
$avatar = get_avatar($user_id);
echo $avatar;

В данном примере мы получаем аватар пользователя по его ID. Функция get_avatar() принимает первым параметром ID пользователя, в данном случае это переменная $user_id. Результатом выполнения функции будет строка с тегом <img>, содержащим аватар пользователя.

Отображение аватара пользователя по email


$email = 'user@example.com'; // Email пользователя
$avatar = get_avatar($email);
echo $avatar;

В этом примере мы получаем аватар пользователя по его email. Передаем email в качестве первого параметра функции get_avatar(). Результатом будет строка с тегом <img>, содержащим аватар пользователя.

Использование MD5-хэша для получения аватара


$md5_hash = '5d41402abc4b2a76b9719d911017c592'; // MD5-хэш пользователя
$avatar = get_avatar($md5_hash);
echo $avatar;

В данном примере мы получаем аватар пользователя по его MD5-хэшу. Передаем хэш в качестве первого параметра функции get_avatar(). Результатом будет строка с тегом <img>, содержащим аватар пользователя.

Получение аватара пользователя по комментарию


$comment_id = 456; // ID комментария
$avatar = get_avatar($comment_id);
echo $avatar;

В этом примере мы получаем аватар пользователя, оставившего комментарий, по ID комментария. Передаем ID комментария в качестве первого параметра функции get_avatar(). Результатом будет строка с тегом <img>, содержащим аватар пользователя.

Получение аватара пользователя по записи


$post_id = 789; // ID записи
$avatar = get_avatar($post_id);
echo $avatar;

В данном примере мы получаем аватар пользователя, автором записи, по ID записи. Передаем ID записи в качестве первого параметра функции get_avatar(). Результатом будет строка с тегом <img>, содержащим аватар пользователя.

Вопросы и ответы

Как изменить размер аватарки, возвращаемой функцией get_avatar()?

Функция get_avatar() позволяет получить тег <img> с аватаркой пользователя. По умолчанию, размер аватарки равен 96 пикселям.

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


$avatar = get_avatar( $user_id, 150 ); // Получение аватарки пользователя с размером 150x150 пикселей
echo $avatar;

Как задать пользовательское изображение по умолчанию для аватарки?

Функция get_avatar() позволяет задать изображение по умолчанию для аватарки, если у пользователя нет своей. По умолчанию, используется значение опции ‘avatar_default’, а если она не установлена, то используется изображение «mystery».

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


$avatar = get_avatar( $user_id, 96, 'https://example.com/default-avatar.jpg' ); // Получение аватарки пользователя с пользовательским изображением по умолчанию
echo $avatar;

Как изменить альтернативный текст для аватарки?

Функция get_avatar() позволяет задать альтернативный текст для аватарки, который будет использоваться в теге <img>. По умолчанию, альтернативный текст не задан.

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


$avatar = get_avatar( $user_id, 96, '', 'Аватар пользователя' ); // Получение аватарки пользователя с альтернативным текстом "Аватар пользователя"
echo $avatar;

Как изменить классы CSS для тега аватарки?

Функция get_avatar() позволяет изменить классы CSS для тега <img> аватарки, добавив атрибут class в параметры функции.


$args = array(
    'class' => 'my-avatar-class',
);
echo get_avatar( $id_or_email, $size, $default_value, $alt, $args );

В данном примере мы добавили класс my-avatar-class к тегу <img> аватарки. Теперь вы можете использовать этот класс для стилизации аватарки с помощью CSS.

Как всегда показывать изображение по умолчанию, а не Gravatar?

Чтобы всегда показывать изображение по умолчанию вместо Gravatar, нужно использовать параметр force_default и установить его значение в true.


$args = array(
    'force_default' => true,
);
echo get_avatar( $id_or_email, $size, $default_value, $alt, $args );

Теперь функция get_avatar() будет всегда выводить изображение по умолчанию, указанное в параметре $default_value, вместо аватарки Gravatar.

Как изменить рейтинг аватарок, отображаемых функцией get_avatar()?

Функция get_avatar() позволяет изменить рейтинг аватарок, отображаемых с помощью параметра rating. Допустимые значения для параметра rating — ‘G’, ‘PG’, ‘R’, ‘X’.


$args = array(
    'rating' => 'PG',
);
echo get_avatar( $id_or_email, $size, $default_value, $alt, $args );

В данном примере мы установили рейтинг аватарок в ‘PG’, что означает, что функция get_avatar() будет отображать только аватарки с рейтингом ‘PG’ и ниже.

Функция get_avatar()

Функция get_avatar() в WordPress используется для получения тега <img> аватарки пользователя, основываясь на его идентификаторе, email, MD5-хэше, комментарии или записи.

Использование функции:

get_avatar( mixed $id_or_email, int $size = 96, string $default_value = '', string $alt = '', array $args = null ): string|false

Функция возвращает тег <img> с аватаркой пользователя или false в случае ошибки.

Как изменить URL-схему для аватарки?

Для изменения URL-схемы аватарки можно использовать параметр scheme в массиве $args. Допустимые значения для scheme можно найти в документации функции set_url_scheme().

Пример кода:

$args = array(
    'scheme' => 'https'
);
echo get_avatar( $user_id, 96, '', '', $args );

Как всегда показывать аватарку, игнорируя настройки отображения аватаров?

Чтобы всегда показывать аватарку пользователя, можно использовать параметр force_display в массиве $args. Установите его значение в true.

Пример кода:

$args = array(
    'force_display' => true
);
echo get_avatar( $user_id, 96, '', '', $args );

Как добавить дополнительные атрибуты HTML для тега <img> аватарки?

Для добавления дополнительных атрибутов HTML для тега <img> аватарки, можно использовать параметр extra_attr в массиве $args.

Пример кода:

$args = array(
    'extra_attr' => 'class="avatar"'
);
echo get_avatar( $user_id, 96, '', '', $args );

Функция get_avatar() в WordPress позволяет получить тег <img> с аватаркой пользователя на основе его идентификатора, email или других параметров. С помощью дополнительных аргументов можно изменить URL-схему, всегда показывать аватарку или добавить дополнительные атрибуты HTML для тега <img>. Эта функция является полезным инструментом для работы с аватарками пользователей в WordPress.

Связанные элементы

  • Функция get_avatar_data(): Возвращает данные, связанные с аватаром пользователя.
  • Функция get_avatar_url(): Возвращает URL-адрес аватара пользователя.
Аватары
Обсуждение

Этот сайт использует cookie для хранения данных. Продолжая использовать сайт, Вы принимаете условия пользовательского соглашения и даете свое согласие на использование cookie.