PluginUiEvent events

7 FeatherPanel plugin events on PluginUiEvent (7 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 23 Oct 2026.

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.

Setup

Import PluginUiEvent 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\PluginUiEvent;

class MyPlugin implements AppPlugin
{
    public static function processEvents(PluginEvents $event): void
    {
        $event->on(PluginUiEvent::onUiError(), function ($source, $message, $context): void {
            App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:system:plugins:ui:error ' . json_encode(['source' => $source, 'message' => $message, 'context' => $context]));
        });
    }

    public static function pluginInstall(): void
    {
    }

    public static function pluginUninstall(): void
    {
    }
}

`PluginUiEvent::onUiError()`

Name: featherpanel:system:plugins:ui:erroremitted at 4 sitesCancel or modify: nodefinition

Docblock: string source, string message, array context metadata.

#	Payload key	Listener parameter	Type
1	`source`	`$source`	`string`
2	`message`	`$message`	`string`from docblock
3	`context`	`$context`	`array`

When it fires (4 sites)

$event->on(PluginUiEvent::onUiError(), function ($source, $message, $context): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:system:plugins:ui:error ' . json_encode(['source' => $source, 'message' => $message, 'context' => $context]));
});

`PluginUiEvent::onOverridesRetrieved()`

Name: featherpanel:system:plugins:ui:overrides:retrievedemitted at 1 siteCancel or modify: nodefinition

Docblock: array overrides from Frontend/overrides.json aggregations. (the emitter passes 3 values, see the table)

#	Payload key	Listener parameter	Type
1	`hide`	`$hide`	`array`
2	`replace`	`$replace`	`array`
3	`actions`	`$actions`	`array`

When it fires (1 site)

PluginOverridesController::indexGET /api/system/plugin-overrides

$event->on(PluginUiEvent::onOverridesRetrieved(), function ($hide, $replace, $actions): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:system:plugins:ui:overrides:retrieved ' . json_encode(['hide' => $hide, 'replace' => $replace, 'actions' => $actions]));
});

`PluginUiEvent::onUiPacksRetrieved()`

Name: featherpanel:system:plugins:ui:packs:retrievedemitted at 1 siteCancel or modify: nodefinition

Docblock: array UI packs from Frontend/ui.json aggregations.

#	Payload key	Listener parameter	Type
1	`packs`	`$packs`	`array`

When it fires (1 site)

PluginUiPacksController::indexGET /api/system/plugin-ui-packs

$event->on(PluginUiEvent::onUiPacksRetrieved(), function ($packs): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:system:plugins:ui:packs:retrieved ' . json_encode(['packs' => $packs]));
});

`PluginUiEvent::onPublicPagesRetrieved()`

Name: featherpanel:system:plugins:ui:public-pages:retrievedemitted at 1 siteCancel or modify: nodefinition

Docblock: array public pages from Frontend/public.json aggregations.

#	Payload key	Listener parameter	Type
1	`pages`	`$pages`	`array`from docblock

When it fires (1 site)

PluginPublicPagesController::indexGET /api/system/plugin-public-pages

$event->on(PluginUiEvent::onPublicPagesRetrieved(), function ($pages): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:system:plugins:ui:public-pages:retrieved ' . json_encode(['pages' => $pages]));
});

`PluginUiEvent::onSidebarRetrieved()`

Name: featherpanel:system:plugins:ui:sidebar:retrievedemitted at 1 siteCancel or modify: nodefinition

Docblock: array sidebar sections, array context metadata.

#	Payload key	Listener parameter	Type
1	`sidebar`	`$sidebar`	`array`
2	`context`	`$context`	`array`

When it fires (1 site)

PluginSidebarController::indexGET /api/system/plugin-sidebar

$event->on(PluginUiEvent::onSidebarRetrieved(), function ($sidebar, $context): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:system:plugins:ui:sidebar:retrieved ' . json_encode(['sidebar' => $sidebar, 'context' => $context]));
});

`PluginUiEvent::onThemesRetrieved()`

Name: featherpanel:system:plugins:ui:themes:retrievedemitted at 1 siteCancel or modify: nodefinition

Docblock: array themes from Frontend/theme.json aggregations.

#	Payload key	Listener parameter	Type
1	`themes`	`$themes`	`array`

When it fires (1 site)

PluginThemesController::indexGET /api/system/plugin-themes

$event->on(PluginUiEvent::onThemesRetrieved(), function ($themes): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:system:plugins:ui:themes:retrieved ' . json_encode(['themes' => $themes]));
});

`PluginUiEvent::onWidgetsRetrieved()`

Name: featherpanel:system:plugins:ui:widgets:retrievedemitted at 1 siteCancel or modify: nodefinition

Docblock: array widgets by page/location, array context metadata.

#	Payload key	Listener parameter	Type
1	`widgets`	`$widgets`	`array`from docblock
2	`context`	`$context`	`array`

When it fires (1 site)

PluginWidgetController::indexGET /api/system/plugin-widgets

$event->on(PluginUiEvent::onWidgetsRetrieved(), function ($widgets, $context): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:system:plugins:ui:widgets:retrieved ' . json_encode(['widgets' => $widgets, 'context' => $context]));
});