get_avatar_data()
Получает массив данных об аватаре, по переданному email, ID, объекту пользователя, объекту поста или комментария.
Эта функция не проверят если ли реально аватар, она просто собирает URL на сервис gravatar.com. Чтобы проверить если ли у email аватар, вам нужно отдельно обработать полученный URL. Нужно указать в default 404, затем получить URL и попробовать получить картинку по этому URL через get_headers(). Если ответ вернет 404, то аватарки у email нет.
Смотрите также функцию get_avatar().
Хуки из функции
Возвращает
Массив
. Массив данных полученного аватара. Массив будет содержать все переданные в параметр $args данные а также дополнительные поля:
-
'found_avatar'
- (логический) true - если аватар пользователя найден, false или пусто - если не найден. 'url'
- (строка) УРЛ найденного аватара.
Возвращаемый параметр 'found_avatar' определен всегда, когда удалось получить картинку аватара, даже если параметр default=404. 'found_avatar' не указывает на то, есть ли у пользователя реальный аватар.
Использование
get_avatar_data( $id_or_email, $args );
- $id_or_email(смешанный) (обязательный)
Идентификатор по которому будет определяться аватар. Может быть:
- email - asd@asd.ru
- gravatar md5 хэш (md5 хэш мыла)
- ID пользователя - получит аватар пользователя по мылу
- WP_User объект - получит аватар пользователя по мылу
- WP_Post объект - получит аватар автора поста
- WP_Comment объект - получит аватар комментатора
- $args(массив)
Параметры получаемого аватара. По умолчанию:
- size(число)
Высота и ширина аватара в пикселях.
По умолчанию: 96 -
default(строка)
УРЛ на картинку по умолчанию - если не удалось получить аватар. Вместо УРЛ можно указать следующие значения:404
- вернет 404 вместо дефолтной картинки.retro
- пиксельная картинка 8bit:monsterid
- монстрик:wavatar
- мульт лицо:indenticon
- картинка-узор:mystery
, 'mm' или 'mysterman' - неизвестный человек:blank
- прозрачная GIF картинка.gravatar_default
- логотип Gravatar:
По умолчанию: значение опции 'avatar_default' или 'mystery'
-
force_default(логический)
Ставим true, если нужно всегда показывать дефолтную картинку и не показывать аватары совсем.
По умолчанию: false -
rating(строка)
Максимально допустимый рейтинг выводимой аватарки. Может быть:G
— Подходит для любой аудитории;PG
— Может содержать оскорбительные элементы, обычно для аудитории старше 13 лет;R
— Рассчитан на взрослую аудиторию старше 17 лет;X
— Для ещё более зрелой аудитории;
По умолчанию: значение опции 'avatar_rating'
-
scheme(строка)
Схема УРЛ, которая будет использоваться. Может быть: 'http', 'https', 'login', 'login_post', 'admin', or 'relative'. Подробнее смотрите функцию set_url_scheme().
По умолчанию: null -
processed_args(массив)
Дополнительные опции для передачи. При фильтрации и возврате данных функцией get_avatar_data() эти параметры будут добавлены в возвращаемый массив.
По умолчанию: null - extra_attr(строка)
HTML атрибуты для добавления к элементу IMG. Не очищаются.
По умолчанию: ''
По умолчанию: null
- size(число)
Примеры
#1 Получим данные аватарки по email юзера
$ava_data = get_avatar_data( 'asd@dsf.df', array( 'size' => 48, 'default'=>'identicon', ) ); /* 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 Получим данные аватара текущего пользователя
$ava_data = get_avatar_data( wp_get_current_user(), array( 'size' => 24, 'default'=>'wavatar', ) ); /* Array ( [size] => 24 [height] => 24 [width] => 24 [default] => wavatar [force_default] => [rating] => g [scheme] => [processed_args] => [extra_attr] => [found_avatar] => 1 [url] => http://1.gravatar.com/avatar/155e695ab2251ee3c482c1e3e690683b?s=24&d=wavatar&r=g ) */
#3 Получим данные аватара автора текущей статьи
global $post; $ava_data = get_avatar_data( $post, "size=52&default=monsterid"); /* Array ( [size] => 52 [height] => 52 [width] => 52 [default] => monsterid [force_default] => [rating] => g [scheme] => [processed_args] => [extra_attr] => [found_avatar] => 1 [url] => http://1.gravatar.com/avatar/155e695ab2251ee3c482c1e3e690683b?s=52&d=monsterid&r=g ) */
#4 Передадим дополнительные параметры
$ava_data = get_avatar_data( 'asd@sd.sd', array( 'processed_args' => array(10,'foo'), 'extra_attr' => 'style="foo"', )); print_r( $ava_data ); /* Array ( [size] => 24 [height] => 24 [width] => 24 [default] => mm [force_default] => [rating] => x [scheme] => [processed_args] => Array ( [0] => 10 [1] => foo ) [extra_attr] => style="foo" [found_avatar] => 1 [url] => http://1.gravatar.com/avatar/4420889f9734a17a5168dbec7891a4c9?s=24&d=mm&r=x ) */
Список изменений
С версии 4.2.0 | Введена. |