Type at least two characters.

↑ ↓ moveEnter openEsc close
View .md

WebSpaceEvent events

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

Setup

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

class MyPlugin implements AppPlugin
{
    public static function processEvents(PluginEvents $event): void
    {
        $event->on(WebSpaceEvent::onWebSpaceAppInstalled(), function (...$args): void {
            App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:app:installed ' . json_encode($args));
        });
    }

    public static function pluginInstall(): void
    {
    }

    public static function pluginUninstall(): void
    {
    }
}

WebSpaceEvent::onWebSpaceAppInstalled()

Name: featherpanel:webspace:app:installedemitted at 9 sitesCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, string app, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (9 sites)
$event->on(WebSpaceEvent::onWebSpaceAppInstalled(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:app:installed ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceAppUpdated()

Name: featherpanel:webspace:app:updatedemitted at 2 sitesCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, string app, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (2 sites)
$event->on(WebSpaceEvent::onWebSpaceAppUpdated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:app:updated ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceBackupCreated()

Name: featherpanel:webspace:backup:createemitted at 2 sitesCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, string|null backup uuid, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (2 sites)
$event->on(WebSpaceEvent::onWebSpaceBackupCreated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:backup:create ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceBackupDeleted()

Name: featherpanel:webspace:backup:deleteemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, string backup uuid, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceBackupDeleted(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:backup:delete ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceBackupRestored()

Name: featherpanel:webspace:backup:restoreemitted at 2 sitesCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, string backup uuid, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (2 sites)
$event->on(WebSpaceEvent::onWebSpaceBackupRestored(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:backup:restore ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceConsoleAccessed()

Name: featherpanel:webspace:console:accessnot emittedCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, array context.

$event->on(WebSpaceEvent::onWebSpaceConsoleAccessed(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:console:access ' . json_encode($args));
});

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

WebSpaceEvent::onWebSpaceCreated()

Name: featherpanel:webspace:createdemitted at 2 sitesCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, array webspace, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (2 sites)
$event->on(WebSpaceEvent::onWebSpaceCreated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:created ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceDatabaseCreated()

Name: featherpanel:webspace:database:createemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, int database id, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceDatabaseCreated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:database:create ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceDatabaseDeleted()

Name: featherpanel:webspace:database:deleteemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, int database id, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceDatabaseDeleted(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:database:delete ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceDeleted()

Name: featherpanel:webspace:deletedemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceDeleted(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:deleted ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceDirectoryCreated()

Name: featherpanel:webspace:directory:createemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, string path, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceDirectoryCreated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:directory:create ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceDnsRecordCreated()

Name: featherpanel:webspace:dns:record:createdemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, array record.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceDnsRecordCreated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:dns:record:created ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceDnsRecordDeleted()

Name: featherpanel:webspace:dns:record:deletedemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, string record id.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceDnsRecordDeleted(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:dns:record:deleted ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceDnsRecordUpdated()

Name: featherpanel:webspace:dns:record:updatedemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, array record.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceDnsRecordUpdated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:dns:record:updated ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceDnsZoneLinked()

Name: featherpanel:webspace:dns:zone:linkedemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, array zone.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceDnsZoneLinked(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:dns:zone:linked ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceDnsZoneUnlinked()

Name: featherpanel:webspace:dns:zone:unlinkedemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, int zone id.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceDnsZoneUnlinked(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:dns:zone:unlinked ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceFilesDeleted()

Name: featherpanel:webspace:files:deleteemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, array paths, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceFilesDeleted(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:files:delete ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceMailboxCreated()

Name: featherpanel:webspace:mailbox:createemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, int mailbox id, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceMailboxCreated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:mailbox:create ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceMailboxDeleted()

Name: featherpanel:webspace:mailbox:deleteemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, int mailbox id, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceMailboxDeleted(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:mailbox:delete ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceReinstalled()

Name: featherpanel:webspace:reinstallemitted at 2 sitesCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (2 sites)
$event->on(WebSpaceEvent::onWebSpaceReinstalled(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:reinstall ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceScheduleCreated()

Name: featherpanel:webspace:schedule:createemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, int schedule id, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceScheduleCreated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:schedule:create ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceScheduleDeleted()

Name: featherpanel:webspace:schedule:deleteemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, int schedule id, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceScheduleDeleted(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:schedule:delete ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceScheduleUpdated()

Name: featherpanel:webspace:schedule:updateemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, int schedule id, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceScheduleUpdated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:schedule:update ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceSftpAccountCreated()

Name: featherpanel:webspace:sftp:account:createdemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, array account.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceSftpAccountCreated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:sftp:account:created ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceSftpAccountDeleted()

Name: featherpanel:webspace:sftp:account:deletedemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, int account id.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceSftpAccountDeleted(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:sftp:account:deleted ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceSftpAccountUpdated()

Name: featherpanel:webspace:sftp:account:updatedemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, array account.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceSftpAccountUpdated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:sftp:account:updated ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceSftpPasswordReset()

Name: featherpanel:webspace:sftp:password:resetemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, int account id.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceSftpPasswordReset(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:sftp:password:reset ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceSubuserCreated()

Name: featherpanel:webspace:subuser:createemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, int subuser id, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceSubuserCreated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:subuser:create ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceSubuserDeleted()

Name: featherpanel:webspace:subuser:deleteemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, int subuser id, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceSubuserDeleted(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:subuser:delete ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceSubuserUpdated()

Name: featherpanel:webspace:subuser:updateemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, int subuser id, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceSubuserUpdated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:subuser:update ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceSuspended()

Name: featherpanel:webspace:suspendedemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceSuspended(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:suspended ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceUnsuspended()

Name: featherpanel:webspace:unsuspendedemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (1 site)
$event->on(WebSpaceEvent::onWebSpaceUnsuspended(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:unsuspended ' . json_encode($args));
});

WebSpaceEvent::onWebSpaceUpdated()

Name: featherpanel:webspace:updatedemitted at 2 sitesCancel or modify: nodefinition

Docblock: string|null user uuid, string webspace uuid, string uuid_short, array changed fields, array context.

The payload is built at runtime, so its keys cannot be read from the source. Accept ...$args and inspect them.

When it fires (2 sites)
$event->on(WebSpaceEvent::onWebSpaceUpdated(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:webspace:updated ' . json_encode($args));
});
Written from the source:FeatherPanel/backend/app/Plugins/Events/Events/WebSpaceEvent.phpFeatherPanel/backend/app/Plugins/PluginEvents.php
View source on GitHubReport a problemLast updated