get_avatar_url()

Извлекает URL аватара
Функция WordPress
INT 4.2.0
WordPress Icon

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

Функция get_avatar_url() возвращает URL-адрес аватара пользователя или граватара на основе предоставленных данных. Она позволяет получить URL-адрес аватара для пользователя по его идентификатору, хешу md5 граватара, электронной почте пользователя, объекту WP_User, объекту WP_Post или объекту WP_Comment. Функция также предоставляет возможность настройки различных параметров, таких как размер аватара, тип источника аватара, использование стандартного изображения по умолчанию и другие.

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

get_avatar_url( mixed $id_or_email, array $args = null ): string|false

Функция get_avatar_url() принимает два параметра: $id_or_email и $args. Параметр $id_or_email является обязательным и представляет собой идентификатор пользователя, хеш md5 граватара, электронную почту пользователя, объект WP_User, объект WP_Post или объект WP_Comment. Параметр $args является необязательным и представляет собой массив аргументов, которые можно использовать для настройки функции. Функция возвращает строку с URL-адресом аватара в случае успеха или false в случае ошибки.

  • $id_or_email (mixed) — Обязательный. Граватар, для которого нужно получить URL. Принимает идентификатор пользователя, хеш md5 граватара, электронную почту пользователя, объект WP_User, объект WP_Post или объект WP_Comment.
  • $args (array) — Необязательный. Аргументы, которые можно использовать вместо аргументов по умолчанию. Включает в себя параметры, такие как размер аватара, тип источника аватара, использование стандартного изображения по умолчанию и другие.

Функция возвращает URL-адрес аватара в виде строки в случае успеха или false в случае ошибки.

<?php
/**
 * Получение URL-адреса аватара пользователя.
 *
 * @param mixed $id_or_email Граватар, для которого нужно получить URL.
 * @param array $args        Аргументы, которые можно использовать вместо аргументов по умолчанию.
 *
 * @return string|false URL-адрес аватара в случае успеха, false в случае ошибки.
 */
$avatar_url = get_avatar_url( $id_or_email, array(
    'size'           => 96, // Размер аватара в пикселях (по умолчанию 96).
    'default'        => 'mystery', // Тип стандартного изображения (по умолчанию 'mystery').
    'force_default'  => false, // Всегда показывать стандартное изображение (по умолчанию false).
    'rating'         => get_option( 'avatar_rating' ), // Рейтинг аватаров (по умолчанию значение опции 'avatar_rating').
    'scheme'         => null, // Схема URL-адреса (по умолчанию null).
    'processed_args' => null, // Обработанные аргументы (по умолчанию null).
) );
if ( $avatar_url ) {
    echo 'URL-адрес аватара: ' . esc_url( $avatar_url );
} else {
    echo 'Не удалось получить URL-адрес аватара.';
}
?>

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

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


$user_id = 123;
$avatar_url = get_avatar_url($user_id);
echo "URL аватара пользователя с ID $user_id: $avatar_url";

В данном примере мы получаем URL аватара пользователя с указанным ID. Переменная $user_id содержит ID пользователя, для которого мы хотим получить аватар. Функция get_avatar_url() возвращает URL аватара на успешное выполнение и false в случае ошибки. Мы выводим полученный URL на экран.

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


$email = 'user@example.com';
$avatar_url = get_avatar_url($email);
echo "URL аватара пользователя с email $email: $avatar_url";

В этом примере мы получаем URL аватара пользователя по его email. Переменная $email содержит email пользователя, для которого мы хотим получить аватар. Функция get_avatar_url() возвращает URL аватара на успешное выполнение и false в случае ошибки. Мы выводим полученный URL на экран.

Получение URL аватара по объекту WP_User


$user = get_user_by('login', 'username');
$avatar_url = get_avatar_url($user);
echo "URL аватара пользователя с именем пользователя 'username': $avatar_url";

В данном примере мы получаем URL аватара пользователя по объекту WP_User. Сначала мы используем функцию get_user_by(), чтобы получить объект пользователя по его имени пользователя. Затем мы передаем этот объект в функцию get_avatar_url(), которая возвращает URL аватара на успешное выполнение и false в случае ошибки. Мы выводим полученный URL на экран.

Получение URL аватара по объекту WP_Post


$post_id = 456;
$post = get_post($post_id);
$avatar_url = get_avatar_url($post);
echo "URL аватара автора записи с ID $post_id: $avatar_url";

В этом примере мы получаем URL аватара автора записи по объекту WP_Post. Сначала мы используем функцию get_post(), чтобы получить объект записи по ее ID. Затем мы передаем этот объект в функцию get_avatar_url(), которая возвращает URL аватара на успешное выполнение и false в случае ошибки. Мы выводим полученный URL на экран.

Получение URL аватара по объекту WP_Comment


$comment_id = 789;
$comment = get_comment($comment_id);
$avatar_url = get_avatar_url($comment);
echo "URL аватара автора комментария с ID $comment_id: $avatar_url";

В данном примере мы получаем URL аватара автора комментария по объекту WP_Comment. Сначала мы используем функцию get_comment(), чтобы получить объект комментария по его ID. Затем мы передаем этот объект в функцию get_avatar_url(), которая возвращает URL аватара на успешное выполнение и false в случае ошибки. Мы выводим полученный URL на экран.

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

Как получить URL аватара по ID пользователя?

Функция get_avatar_url() позволяет получить URL аватара пользователя по его ID. Для этого необходимо передать ID пользователя в качестве аргумента $id_or_email. Например:


$user_id = 123;
$avatar_url = get_avatar_url($user_id);

Как получить URL аватара по email пользователя?

Если известен email пользователя, можно также получить его аватар с помощью функции get_avatar_url(). Для этого необходимо передать email в качестве аргумента $id_or_email. Например:


$user_email = 'user@example.com';
$avatar_url = get_avatar_url($user_email);

Как получить URL аватара по объекту WP_User?

Функция get_avatar_url() также позволяет получить URL аватара пользователя, если у вас есть объект WP_User. Для этого необходимо передать объект WP_User в качестве аргумента $id_or_email. Например:


$user = get_user_by('login', 'username');
$avatar_url = get_avatar_url($user);

Функция get_avatar_url() возвращает URL аватара пользователя в виде строки в случае успеха и false в случае ошибки. По умолчанию, размер аватара равен 96 пикселям, но его можно изменить, передав значение в аргументе $args. Также можно указать URL для изображения по умолчанию, тип изображения по умолчанию, принудительное отображение изображения по умолчанию и другие параметры.

Как получить URL аватара по объекту WP_Post?

Для получения URL аватара по объекту WP_Post можно использовать функцию get_avatar_url(). В качестве параметра $id_or_email передается объект WP_Post.

$post = get_post( $post_id );
$avatar_url = get_avatar_url( $post );

Как получить URL аватара по объекту WP_Comment?

Аналогично, для получения URL аватара по объекту WP_Comment используется функция get_avatar_url(). В качестве параметра $id_or_email передается объект WP_Comment.

$comment = get_comment( $comment_id );
$avatar_url = get_avatar_url( $comment );

Как изменить размер аватара?

Для изменения размера аватара можно использовать параметр $args функции get_avatar_url(). В массиве $args указывается параметр size с требуемыми значениями ширины и высоты аватара в пикселях.

$avatar_url = get_avatar_url( $id_or_email, array(
    'size' => 200
) );

Итак, функция get_avatar_url() позволяет получить URL аватара по объекту WP_Post или WP_Comment. Также, с помощью параметра $args можно изменить размер аватара.

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

Функция get_avatar_url() позволяет получить URL аватара пользователя. По умолчанию, если у пользователя не установлен аватар, используется Gravatar. Можно изменить тип аватара по умолчанию, указав другой URL или тип изображения.

Для этого необходимо передать параметр default в массиве аргументов $args. Возможные значения параметра default:

  • 404 — вернуть ошибку 404, если аватар не найден;
  • retro — использовать 8-битное изображение;
  • RoboHash — использовать изображение сгенерированное сервисом RoboHash;
  • monsterid — использовать изображение монстра;
  • wavatar — использовать изображение лица в стиле комикса;
  • indenticon — использовать «quilt» изображение;
  • mystery — использовать загадочное изображение;
  • mm или mysteryman — использовать изображение «The Oyster Man»;
  • blank — использовать прозрачное изображение формата GIF;
  • gravatar_default — использовать логотип Gravatar.

Пример кода:


$args = array(
  'default' => 'monsterid'
);
$avatar_url = get_avatar_url( $user_id, $args );

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

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

Пример кода:


$args = array(
  'default' => 'monsterid',
  'force_default' => true
);
$avatar_url = get_avatar_url( $user_id, $args );

Как изменить рейтинг аватаров?

Функция get_avatar_url() позволяет указать рейтинг аватаров, которые будут отображаться. Рейтинг определяется параметром rating в массиве аргументов $args.

Возможные значения параметра rating:

  • G — аватары с рейтингом G (для всех возрастных категорий);
  • PG — аватары с рейтингом PG (рекомендуется для детей);
  • R — аватары с рейтингом R (ограниченный контент);
  • X — аватары с рейтингом X (для взрослых).

Пример кода:


$args = array(
  'rating' => 'PG'
);
$avatar_url = get_avatar_url( $user_id, $args );

Функция get_avatar_url() позволяет получить URL аватара пользователя в WordPress. С помощью нее можно изменить тип аватара по умолчанию, указав другой URL или тип изображения. Также можно настроить отображение только аватара по умолчанию, без использования Gravatar. Кроме того, функция позволяет изменить рейтинг аватаров, которые будут отображаться. Это полезно, если требуется ограничить контент или выбрать аватары для определенной возрастной категории.

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

  • Функция get_avatar(): Возвращает HTML-код аватара пользователя или объекта комментария.
  • Функция get_avatar_data(): Возвращает данные аватара пользователя или объекта комментария.
  • Хук pre_get_avatar_data: Позволяет изменить данные аватара перед их получением.
  • Хук get_avatar: Позволяет изменить HTML-код аватара перед его выводом.
  • Хук get_avatar_url: Позволяет изменить URL аватара перед его получением.
  • Хук get_avatar_comment_types: Позволяет изменить типы комментариев, для которых отображается аватар.
Обсуждение