diff options
Diffstat (limited to 'doc/en_US/plugin-avatar-provider.markdown')
-rw-r--r-- | doc/en_US/plugin-avatar-provider.markdown | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/en_US/plugin-avatar-provider.markdown b/doc/en_US/plugin-avatar-provider.markdown new file mode 100644 index 00000000..62941e5c --- /dev/null +++ b/doc/en_US/plugin-avatar-provider.markdown @@ -0,0 +1,32 @@ +Adding a new Avatar Provider +============================= + +Registration +------------ + +```php +$this->avatarManager->register(new CustomAvatarProvider()); +``` + +Interface +--------- + +The provider must implements the interface `Kanboard\Core\User\Avatar\AvatarProviderInterface`: + + +| Method | Description | +|-------------------------------|---------------------------------------------------------------| +| `render(array $user, $size)` | Render HTML | +| `isActive(array $user)` | Returns a boolean if the provider is able to render something | + + +The `$user` argument is a dictionary that contains these keys: + +```php +[ + 'id' => 123, + 'username' => 'admin', + 'name' => 'Administrator', + 'email' => 'me@localhost', +] +``` |