Skip to content

EasyAdmin Avatar Field

Edit this page

This field displays an image representing the avatar of a user based on the value of some entity property.

In form pages (edit and new) it renders the avatar image URL in a <input type="text"> field. In read-only pages (index and detail) it renders the <img> element represented by that URL.

Basic Information

  • PHP Class: EasyCorp\Bundle\EasyAdminBundle\Field\AvatarField
  • Doctrine DBAL Type used to store this value: string or text
  • Symfony Form Type used to render the field: TextType
  • Rendered as:

    1
    <input type="text">

Options

setHeight

Avatar images are rendered as squares, so there are only one option to set the height, which will be the same as its width. By default, avatars images are 24px height in index page and 48px height in detail page. Use this option to customize this value:

1
2
3
4
5
6
7
8
9
10
// if you pass an integer, it's considered the height in pixels
yield AvatarField::new('...')->setHeight(36);

// you can also use any of these predefined sizes:
// 'sm' = 18px; 'md' = 24px; 'lg' = 48px; 'xl' = 96px
yield AvatarField::new('...')->setHeight('lg');

// inside configureFields() you have access to the current page name
// use it to set different values per page
yield AvatarField::new('...')->setHeight($pageName === Crud::PAGE_DETAIL ? 'lg' : 21);

setIsGravatarEmail

By default, EasyAdmin considers that the value stored in the property is the full URL of the avatar image. If you use Gravatar service, set this option to tell EasyAdmin that it has to generate the avatar image URL dynamically using the email stored in the property:

1
2
// turns the email into an URL of the format: 'https://www.gravatar.com/avatar/...'
yield AvatarField::new('someEmail')->setIsGravatarEmail();
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
TOC
    Version