SubdomainsEvent events

10 FeatherPanel plugin events on SubdomainsEvent (9 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. 1 of these events are declared but no code emits them yet; they are marked not emitted.

Setup

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

class MyPlugin implements AppPlugin
{
    public static function processEvents(PluginEvents $event): void
    {
        $event->on(SubdomainsEvent::onSubdomainDomainNotFound(), function ($domainUuid, $errorMessage): void {
            App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:subdomains:domain:not:found ' . json_encode(['domain_uuid' => $domainUuid, 'error_message' => $errorMessage]));
        });
    }

    public static function pluginInstall(): void
    {
    }

    public static function pluginUninstall(): void
    {
    }
}

`SubdomainsEvent::onSubdomainDomainCreated()`

Name: featherpanel:admin:subdomains:domain:createdemitted at 1 siteCancel or modify: nodefinition

Docblock: array domain data. (the emitter passes 2 values, see the table)

#	Payload key	Listener parameter	Type
1	`domain_data`	`$domainData`	not declared
2	`created_by`	`$createdBy`	not declared

When it fires (1 site)

SubdomainsController::createPUT /api/admin/subdomains

$event->on(SubdomainsEvent::onSubdomainDomainCreated(), function ($domainData, $createdBy): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:subdomains:domain:created');
});

`SubdomainsEvent::onSubdomainDomainDeleted()`

Name: featherpanel:admin:subdomains:domain:deletedemitted at 1 siteCancel or modify: nodefinition

Docblock: string domain uuid, array domain data. (the emitter passes 3 values, see the table)

#	Payload key	Listener parameter	Type
1	`domain_uuid`	`$domainUuid`	`string`
2	`domain_data`	`$domainData`	not declared
3	`deleted_by`	`$deletedBy`	not declared

When it fires (1 site)

SubdomainsController::deleteDELETE /api/admin/subdomains/{uuid}

$event->on(SubdomainsEvent::onSubdomainDomainDeleted(), function ($domainUuid, $domainData, $deletedBy): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:subdomains:domain:deleted ' . json_encode(['domain_uuid' => $domainUuid]));
});

`SubdomainsEvent::onSubdomainDomainNotFound()`

Name: featherpanel:admin:subdomains:domain:not:foundemitted at 1 siteCancel or modify: nodefinition

Docblock: string domain uuid, string error message.

#	Payload key	Listener parameter	Type
1	`domain_uuid`	`$domainUuid`	`string`
2	`error_message`	`$errorMessage`	`string`

When it fires (1 site)

SubdomainsController::listSubdomainsGET /api/admin/subdomains/{uuid}/subdomains

$event->on(SubdomainsEvent::onSubdomainDomainNotFound(), function ($domainUuid, $errorMessage): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:subdomains:domain:not:found ' . json_encode(['domain_uuid' => $domainUuid, 'error_message' => $errorMessage]));
});

`SubdomainsEvent::onSubdomainDomainRetrieved()`

Name: featherpanel:admin:subdomains:domain:retrievedemitted at 1 siteCancel or modify: nodefinition

Docblock: string domain uuid, array domain data.

#	Payload key	Listener parameter	Type
1	`domain_uuid`	`$domainUuid`	`string`from docblock
2	`domain_data`	`$domainData`	`array`from docblock

When it fires (1 site)

SubdomainsController::showGET /api/admin/subdomains/{uuid}

$event->on(SubdomainsEvent::onSubdomainDomainRetrieved(), function ($domainUuid, $domainData): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:subdomains:domain:retrieved ' . json_encode(['domain_uuid' => $domainUuid, 'domain_data' => $domainData]));
});

`SubdomainsEvent::onSubdomainDomainUpdated()`

Name: featherpanel:admin:subdomains:domain:updatedemitted at 1 siteCancel or modify: nodefinition

Docblock: string domain uuid, array old data, array new data. (the emitter passes 4 values, see the table)

#	Payload key	Listener parameter	Type
1	`domain_uuid`	`$domainUuid`	`string`
2	`old_data`	`$oldData`	not declared
3	`new_data`	`$newData`	not declared
4	`updated_by`	`$updatedBy`	not declared

When it fires (1 site)

SubdomainsController::updatePATCH /api/admin/subdomains/{uuid}

$event->on(SubdomainsEvent::onSubdomainDomainUpdated(), function ($domainUuid, $oldData, $newData, $updatedBy): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:subdomains:domain:updated ' . json_encode(['domain_uuid' => $domainUuid]));
});

`SubdomainsEvent::onSubdomainDomainsRetrieved()`

Name: featherpanel:admin:subdomains:domains:retrievedemitted at 1 siteCancel or modify: nodefinition

Docblock: array domains list. (the emitter passes 3 values, see the table)

#	Payload key	Listener parameter	Type
1	`domains`	`$domains`	not declared
2	`pagination`	`$pagination`	`array`
3	`filters`	`$filters`	`array`

When it fires (1 site)

SubdomainsController::indexGET /api/admin/subdomains

$event->on(SubdomainsEvent::onSubdomainDomainsRetrieved(), function ($domains, $pagination, $filters): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:subdomains:domains:retrieved ' . json_encode(['pagination' => $pagination, 'filters' => $filters]));
});

`SubdomainsEvent::onSubdomainsError()`

Name: featherpanel:admin:subdomains:errornot emittedCancel or modify: nodefinition

Docblock: string error message, array context.

$event->on(SubdomainsEvent::onSubdomainsError(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:subdomains:error ' . json_encode($args));
});

No code emits this event yet, so the arguments are unknown. The listener accepts any.

`SubdomainsEvent::onSubdomainSettingsUpdated()`

Name: featherpanel:admin:subdomains:settings:updatedemitted at 2 sitesCancel or modify: nodefinition

Docblock: array settings data. (the emitter passes 2 values, see the table)

#	Payload key	Listener parameter	Type
1	`settings`	`$settings`	`array`
2	`updated_by`	`$updatedBy`	not declared

When it fires (2 sites)

$event->on(SubdomainsEvent::onSubdomainSettingsUpdated(), function ($settings, $updatedBy): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:subdomains:settings:updated ' . json_encode(['settings' => $settings]));
});

`SubdomainsEvent::onSubdomainCreated()`

Name: featherpanel:user:subdomain:createdemitted at 2 sites2 payload shapesCancel or modify: nodefinition

Docblock: string subdomain uuid, array subdomain data, array server data. (the emitter passes 4 values, see the table)

#	Payload key	Listener parameter	Type
1	`subdomain_uuid`	`$subdomainUuid`not at every site	not declared
2	`subdomain_data`	`$subdomainData`not at every site	not declared
3	`server_data`	`$serverData`not at every site	`array`
4	`user`	`$user`not at every site	not declared

Arguments passed	Emitted from
`subdomain_uuid`, `subdomain_data`, `server_data`, `user`	`SubdomainController::create`
`user_uuid`, `subdomain_uuid`, `subdomain_data`, `server_data`	`CreateSubdomainTool::execute`

When it fires (2 sites)

$event->on(SubdomainsEvent::onSubdomainCreated(), function (...$rest): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:subdomain:created');
});

`SubdomainsEvent::onSubdomainDeleted()`

Name: featherpanel:user:subdomain:deletedemitted at 2 sites2 payload shapesCancel or modify: nodefinition

Docblock: string subdomain uuid, array subdomain data, array server data. (the emitter passes 4 values, see the table)

#	Payload key	Listener parameter	Type
1	`subdomain_uuid`	`$subdomainUuid`not at every site	`string`
2	`subdomain_data`	`$subdomainData`not at every site	not declared
3	`server_data`	`$serverData`not at every site	`array`
4	`user`	`$user`not at every site	not declared

Arguments passed	Emitted from
`subdomain_uuid`, `subdomain_data`, `server_data`, `user`	`SubdomainController::delete`
`user_uuid`, `subdomain_uuid`, `subdomain_data`, `server_data`	`DeleteSubdomainTool::execute`

When it fires (2 sites)

$event->on(SubdomainsEvent::onSubdomainDeleted(), function (...$rest): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:subdomain:deleted');
});