Функция get_avatar_data() в WordPress с примерами

Главная - WordPress Codex - Функция get_avatar_data() в WordPress с примерами
Доступна с версии: 4.2
Раздел: Комментарии
Написал: Александр Сокирка

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

get_avatar_data( mixed $id_or_email, array $args = null ): array

Параметры:

  • $id_or_email (смешанный) — Обязательный параметр. Указывает на аватар, который необходимо получить. Может принимать следующие значения:
    • ID пользователя
    • Хэш Gravatar (MD5)
    • Email пользователя
    • Объект WP_User
    • Объект WP_Post
    • Объект WP_Comment
  • $args (массив) — Необязательный параметр. Массив аргументов, которые будут использованы вместо аргументов по умолчанию. Включает следующие параметры:
    • size (число) — Размер аватара в пикселях (ширина и высота). По умолчанию: 96.
    • height (число) — Высота аватара. По умолчанию: значение size.
    • width (число) — Ширина аватара. По умолчанию: значение size.
    • default (строка) — URL изображения по умолчанию или тип изображения (например, 'mystery', 'retro', 'wavatar').
    • force_default (логический) — Если true, то всегда будет показываться изображение по умолчанию, даже если Gravatar доступен. По умолчанию: false.
    • rating (строка) — Рейтинг изображения аватара. Принимает значения: 'G', 'PG', 'R', 'X'. По умолчанию: 'G'.
    • scheme (строка) — Схема URL (например, http, https). По умолчанию: null.
    • processed_args (массив) — Массив обработанных аргументов. Добавляется в возвращаемый массив.
    • extra_attr (строка) — Дополнительные HTML-атрибуты для изображения (не фильтруются). По умолчанию: пусто.

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

Возвращает массив с данными об аватаре, включающий как переданные параметры, так и дополнительные поля:

  • found_avatar (логический) — Определяет, найден ли аватар. true, если аватар найден, false — если не найден.
  • url (строка|false) — URL найденного аватара или false, если аватар не найден.

Пример 1: Получение данных аватара по email

$avatar_data = get_avatar_data( '[email protected]', array(
    'size' => 48,
    'default' => 'identicon',
));

print_r( $avatar_data );

Результат:

Array
(
    [size] => 48
    [height] => 48
    [width] => 48
    [default] => identicon
    [force_default] => 
    [rating] => g
    [scheme] => 
    [processed_args] => 
    [extra_attr] => 
    [found_avatar] => 1
    [url] => http://1.gravatar.com/avatar/4b508f04b661ba693130539bd29f5c0d?s=48&d=identicon&r=g
)

Пример 2: Получение аватара текущего пользователя

$current_user = wp_get_current_user();
$avatar_data = get_avatar_data( $current_user, array(
    'size' => 24,
    'default' => 'wavatar',
));

print_r( $avatar_data );

Пример 3: Получение аватара автора текущего поста

global $post;
$avatar_data = get_avatar_data( $post, array(
    'size' => 52,
    'default' => 'monsterid',
));

print_r( $avatar_data );

Хуки в функции:

  • pre_get_avatar_data — Позволяет изменить данные до их обработки.
  • get_avatar_data — Применяется к данным после их обработки.
  • get_avatar_url — Применяется к URL аватара перед его возвращением.

Заключение

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

Стартовая премиум тема для WordPress
Демо импорт тестового контента в 1 клик.
SEO оптимизированный и валидный код.
Множество готовых стартовых сайтов.
Лучшая документация и поддержка.
Опции персонализации контента.
Креативный и современный дизайн.
Тема для WordPress

Дополнительно по: Комментарии