PHP integration of unavatar service.
This package provides a PHP OOP builder for unavatar.
You can install the package via composer:
composer require astrotomic/php-unavatar
To create an
Unavatar instance you can simply create one or use one of the static helper methods.
Please refer to the unavatar docs for a full documentation of possibilities.
use Astrotomic\Unavatar\Unavatar; $unavatar = new Unavatar('email@example.com'); Unavatar::email('firstname.lastname@example.org'); Unavatar::username('Astrotomic'); Unavatar::domain('astrotomic.info'); Unavatar::github('Astrotomic');
You can also add a fallback image URL that's used if no image is found.
You can call
toUrl() on your
Unavatar instance to retrieve the full generated URL.
You can also call
toImg() on your
Unavatar instance to get a full HTML
$unavatar->toImg(['loading' => 'lazy']);
<img alt="email@example.com's avatar" loading="lazy" src="https://unavatar.now.sh/email%40example.com/?fallback=https%3A%2F%2Fexample.com%2Fimage.jpg" />
Please see CHANGELOG for more information what has changed recently.
If you discover any security related issues, please check SECURITY for steps to report it.
The MIT License (MIT). Please see License File for more information.
You're free to use this package, but if it makes it to your production environment I would highly appreciate you buying the world a tree.
It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you contribute to my forest you’ll be creating employment for local families and restoring wildlife habitats.
You can buy trees at offset.earth/treeware
Read more about Treeware at treeware.earth