Plugin events reference

All 465 FeatherPanel plugin event methods (436 event names), grouped by area, with the arguments each listener gets, where the core emits it and a PHP listener for each one.

Last synced from FeatherPanel 15b94e9 on 23 Oct 2026.

How events work

Every event name is a string returned by a static method on a class in App\Plugins\Events\Events, for example UserEvent::onUserCreated() returns featherpanel:user:created. Register listeners in the processEvents() method of your entry class. The plugin loader calls it for every plugin it loads; it does not check the hasEvents flag, but set it anyway as the manifest docs describe. An exception thrown inside processEvents() itself is caught and logged as "Failed to process plugin event". The behaviour of the listeners is read from PluginEvents.php:

• Arguments are positional. emit() calls each listener with ...array_values($payload), so a listener gets the payload values in the order the emitter wrote them. The keys are not passed. Name your parameters whatever you like, but keep the order.
• Listeners cannot cancel or change the action. emit() returns nothing and runs after the core has done its work in almost every case. Arrays and scalars are copies. Objects are passed by handle, so a listener that receives an object (the RouteCollection in router::Ready, for example) works on the same instance.
• Exceptions are not caught. There is no try/catch around listeners. An exception thrown in a listener reaches the controller that emitted the event and can turn a successful request into an error. Catch your own errors.
• Listeners run in order of registration, synchronously, inside the request that emitted the event.
• 36 events have more than one payload. When emit sites pass different argument lists, the same position can hold different values. For example featherpanel:user:created gets (user, created_by) from PterodactylImporterController::importUser and (user, user_id, uuid, created_by) from UsersController::create. The category pages flag these events; name only the shared leading arguments and take the rest with ...$rest.
• Some names have two methods. 58 methods return a name that another method also returns (for example ServerEvent::onServerFileWritten() and ServerFilesEvent::onServerFileSaved()). Listeners are keyed by the name, so either method receives every emit of it.

The list is generated from the event classes and checked against the hand-written events.md in the panel repository: 465 rows, all of them match. Each category page lists the arguments per event, the emit sites with the endpoint that triggers them, and a listener you can paste. Types come from the emitting code: a literal or cast, a typed function parameter, or the event's docblock when the code does not say. A blank type means the value comes from a variable whose type the code does not declare; it is usually an array row from the database.

Listener example

AuthEvent::onAuthEmailLoginCodeRequested() is emitted with 2 values: user (array), ip_address (string). The listener takes them in that order:

<?php

namespace App\Addons\myplugin;

use App\App;
use App\Plugins\AppPlugin;
use App\Plugins\PluginEvents;
use App\Plugins\Events\Events\AuthEvent;

class MyPlugin implements AppPlugin
{
    public static function processEvents(PluginEvents $event): void
    {
        $event->on(AuthEvent::onAuthEmailLoginCodeRequested(), function ($user, $ipAddress): void {
            App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:auth:email:login:code:requested ' . json_encode(['user' => $user, 'ip_address' => $ipAddress]));
        });
    }

    public static function pluginInstall(): void
    {
    }

    public static function pluginUninstall(): void
    {
    }
}

See Lifecycle and events for when processEvents() runs and Power SDK reference for the frontend events (fp:*) that run in the browser.

Categories

All events

Filter by event name, method, category or argument. Click a row to open the event with its payload and example.

465 events