ImagesEvent events
7 FeatherPanel plugin events on ImagesEvent (3 emitted by the core): the event names, the arguments each listener gets, where they fire and a PHP listener for each.
Last synced from FeatherPanel 15b94e9 on .
On this page
Part of the plugin events reference. Listeners get the payload values as positional arguments in the order shown, cannot cancel the action, and must catch their own exceptions. 4 of these events are declared but no code emits them yet; they are marked not emitted.
Setup
Import ImagesEvent in your entry class and register listeners in processEvents():
<?php
namespace App\Addons\myplugin;
use App\App;
use App\Plugins\AppPlugin;
use App\Plugins\PluginEvents;
use App\Plugins\Events\Events\ImagesEvent;
class MyPlugin implements AppPlugin
{
public static function processEvents(PluginEvents $event): void
{
$event->on(ImagesEvent::onImageDeleted(), function ($image, $deletedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:images:image:deleted ' . json_encode(['image' => $image, 'deleted_by' => $deletedBy]));
});
}
public static function pluginInstall(): void
{
}
public static function pluginUninstall(): void
{
}
}ImagesEvent::onImagesError()
Docblock: string error message, array context.
$event->on(ImagesEvent::onImagesError(), function (...$args): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:images:error ' . json_encode($args));
});No code emits this event yet, so the arguments are unknown. The listener accepts any.
ImagesEvent::onImageCreated()
Docblock: array image data. (the emitter passes 3 values, see the table)
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | image_id | $imageId | not declared |
| 2 | image_data | $imageData | not declared |
| 3 | created_by | $createdBy | not declared |
When it fires (1 site)
$event->on(ImagesEvent::onImageCreated(), function ($imageId, $imageData, $createdBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:images:image:created');
});ImagesEvent::onImageDeleted()
Docblock: int image id, array image data.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | image | $image | intfrom docblock |
| 2 | deleted_by | $deletedBy | arrayfrom docblock |
When it fires (1 site)
$event->on(ImagesEvent::onImageDeleted(), function ($image, $deletedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:images:image:deleted ' . json_encode(['image' => $image, 'deleted_by' => $deletedBy]));
});ImagesEvent::onImageNotFound()
Docblock: int image id, string error message.
$event->on(ImagesEvent::onImageNotFound(), function (...$args): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:images:image:not:found ' . json_encode($args));
});No code emits this event yet, so the arguments are unknown. The listener accepts any.
ImagesEvent::onImageRetrieved()
Docblock: int image id, array image data.
$event->on(ImagesEvent::onImageRetrieved(), function (...$args): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:images:image:retrieved ' . json_encode($args));
});No code emits this event yet, so the arguments are unknown. The listener accepts any.
ImagesEvent::onImageUpdated()
Docblock: int image id, array old data, array new data.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | image | $image | intfrom docblock |
| 2 | updated_data | $updatedData | arrayfrom docblock |
| 3 | updated_by | $updatedBy | arrayfrom docblock |
When it fires (1 site)
$event->on(ImagesEvent::onImageUpdated(), function ($image, $updatedData, $updatedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:images:image:updated ' . json_encode(['image' => $image, 'updated_data' => $updatedData, 'updated_by' => $updatedBy]));
});ImagesEvent::onImagesRetrieved()
Docblock: array images list.
$event->on(ImagesEvent::onImagesRetrieved(), function (...$args): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:images:retrieved ' . json_encode($args));
});No code emits this event yet, so the arguments are unknown. The listener accepts any.