README

This bundle allows you to display your avatar anywhere on your site, via the Gravatar service.

Requirements

• Symfony 7.4 and 8.x
• PHP 8.4 or higher
• A Gravatar account - it's free!

Installation

1. To install this bundle, run the following Composer command :

composer require pyrrah/gravatar-bundle

1. If you always have some default for your gravatars such as size, rating, default image, or format, it can be configured in your config:

# config/packages/pyrrah_gravatar.yaml
pyrrah_gravatar:
  rating: "g"      # Allowed values: g, pg, r, x
  size: 80         # Image size in pixels
  default: "mp"   # Default image type (e.g. mp, identicon, monsterid, wavatar, retro, robohash, blank, 404)
  format: "base64" # Output format: url, base64

Note

The format option is specific to the bundle to choose the output format :

• url (default) : returns the https URL of the Gravatar image
• base64 : returns a base64-formatted image generated from the Gravatar URL

Tip: Use the "base64" option to hide your email hash used in the Gravatar URL.

Usage

All you have to do is use the helper like this example:

<img src="{{ gravatar('alias@domain.tld') }}" />

Or if you want to check if a gravatar email exists:

{% if gravatar_exists('alias@domain.tld') %}
  The email is an gravatar email
{% endif %}

Or with parameters (including default):

<img src="{{ gravatar('alias@domain.tld', size, rating, default, format) }}" />

Where:

• size (int) : Image size in pixels
• rating (string) : Allowed values: g, pg, r, x
• default (string) : Default image type (e.g. mp, identicon, monsterid, wavatar, retro, robohash, blank, 404)
• format (string) : Output format: url, base64

For more information look at the gravatar implementation pages.

Credits

• Pierre-Yves Dick
• All Contributors

License

The MIT License (MIT). Please see License File for more information.