RateLimiterEvent events

4 FeatherPanel plugin events on RateLimiterEvent (4 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 RateLimiterEvent 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\RateLimiterEvent;

class MyPlugin implements AppPlugin
{
    public static function processEvents(PluginEvents $event): void
    {
        $event->on(RateLimiterEvent::onRateLimiterBulkUpdated(), function ($userUuid, $updatedRoutes, $errors): void {
            App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:rate-limiter:bulk:update ' . json_encode(['user_uuid' => $userUuid, 'updated_routes' => $updatedRoutes, 'errors' => $errors]));
        });
    }

    public static function pluginInstall(): void
    {
    }

    public static function pluginUninstall(): void
    {
    }
}

`RateLimiterEvent::onRateLimiterBulkUpdated()`

Name: featherpanel:rate-limiter:bulk:updateemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, array updated routes, array errors.

#	Payload key	Listener parameter	Type
1	`user_uuid`	`$userUuid`	`string\|null`from docblock
2	`updated_routes`	`$updatedRoutes`	`array`
3	`errors`	`$errors`	`array`

When it fires (1 site)

RateLimitController::bulkUpdate via emitEvent()PATCH /api/admin/rate-limits/bulk

$event->on(RateLimiterEvent::onRateLimiterBulkUpdated(), function ($userUuid, $updatedRoutes, $errors): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:rate-limiter:bulk:update ' . json_encode(['user_uuid' => $userUuid, 'updated_routes' => $updatedRoutes, 'errors' => $errors]));
});

`RateLimiterEvent::onRateLimiterDeleted()`

Name: featherpanel:rate-limiter:deleteemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string route name.

#	Payload key	Listener parameter	Type
1	`user_uuid`	`$userUuid`	`string\|null`from docblock
2	`route_name`	`$routeName`	`string`

When it fires (1 site)

RateLimitController::delete via emitEvent()DELETE /api/admin/rate-limits/{routeName}

$event->on(RateLimiterEvent::onRateLimiterDeleted(), function ($userUuid, $routeName): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:rate-limiter:delete ' . json_encode(['user_uuid' => $userUuid, 'route_name' => $routeName]));
});

`RateLimiterEvent::onRateLimiterGlobalUpdated()`

Name: featherpanel:rate-limiter:global:updateemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, bool enabled.

#	Payload key	Listener parameter	Type
1	`user_uuid`	`$userUuid`	`string\|null`from docblock
2	`enabled`	`$enabled`	`bool`

When it fires (1 site)

RateLimitController::updateGlobal via emitEvent()PATCH /api/admin/rate-limits/global

$event->on(RateLimiterEvent::onRateLimiterGlobalUpdated(), function ($userUuid, $enabled): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:rate-limiter:global:update ' . json_encode(['user_uuid' => $userUuid, 'enabled' => $enabled]));
});

`RateLimiterEvent::onRateLimiterUpdated()`

Name: featherpanel:rate-limiter:updateemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string route name, array config.

#	Payload key	Listener parameter	Type
1	`user_uuid`	`$userUuid`	`string\|null`from docblock
2	`route_name`	`$routeName`	`string`
3	`config`	`$config`	`array`from docblock

When it fires (1 site)

RateLimitController::update via emitEvent()PUT /api/admin/rate-limits/{routeName}

$event->on(RateLimiterEvent::onRateLimiterUpdated(), function ($userUuid, $routeName, $config): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:rate-limiter:update ' . json_encode(['user_uuid' => $userUuid, 'route_name' => $routeName, 'config' => $config]));
});