KnowledgebaseEvent events
23 FeatherPanel plugin events on KnowledgebaseEvent (23 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.
Setup
Import KnowledgebaseEvent 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\KnowledgebaseEvent;
class MyPlugin implements AppPlugin
{
public static function processEvents(PluginEvents $event): void
{
$event->on(KnowledgebaseEvent::onKnowledgebaseArticleCreated(), function ($article, $createdBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:article:created ' . json_encode(['article' => $article, 'created_by' => $createdBy]));
});
}
public static function pluginInstall(): void
{
}
public static function pluginUninstall(): void
{
}
}KnowledgebaseEvent::onKnowledgebaseArticleCreated()
Docblock: array article, array created_by.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | article | $article | arrayfrom docblock |
| 2 | created_by | $createdBy | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseArticleCreated(), function ($article, $createdBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:article:created ' . json_encode(['article' => $article, 'created_by' => $createdBy]));
});KnowledgebaseEvent::onKnowledgebaseArticleDeleted()
Docblock: array article, array deleted_by.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | article | $article | arrayfrom docblock |
| 2 | deleted_by | $deletedBy | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseArticleDeleted(), function ($article, $deletedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:article:deleted ' . json_encode(['article' => $article, 'deleted_by' => $deletedBy]));
});KnowledgebaseEvent::onKnowledgebaseArticleRetrieved()
Docblock: array article.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | article | $article | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseArticleRetrieved(), function ($article): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:article:retrieved ' . json_encode(['article' => $article]));
});KnowledgebaseEvent::onKnowledgebaseArticleUpdated()
Docblock: array article, array updated_by.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | article | $article | arrayfrom docblock |
| 2 | updated_by | $updatedBy | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseArticleUpdated(), function ($article, $updatedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:article:updated ' . json_encode(['article' => $article, 'updated_by' => $updatedBy]));
});KnowledgebaseEvent::onKnowledgebaseArticlesReordered()
Docblock: array articles, array reordered_by.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | articles | $articles | array |
| 2 | reordered_by | $reorderedBy | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseArticlesReordered(), function ($articles, $reorderedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:articles:reordered ' . json_encode(['articles' => $articles, 'reordered_by' => $reorderedBy]));
});KnowledgebaseEvent::onKnowledgebaseArticlesRetrieved()
Docblock: array articles, array pagination, array search.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | articles | $articles | arrayfrom docblock |
| 2 | pagination | $pagination | array |
| 3 | search | $search | array |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseArticlesRetrieved(), function ($articles, $pagination, $search): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:articles:retrieved ' . json_encode(['articles' => $articles, 'pagination' => $pagination, 'search' => $search]));
});KnowledgebaseEvent::onKnowledgebaseAttachmentDeleted()
Docblock: array article, array attachment, array deleted_by.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | article | $article | arrayfrom docblock |
| 2 | attachment | $attachment | arrayfrom docblock |
| 3 | deleted_by | $deletedBy | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseAttachmentDeleted(), function ($article, $attachment, $deletedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:attachment:deleted ' . json_encode(['article' => $article, 'attachment' => $attachment, 'deleted_by' => $deletedBy]));
});KnowledgebaseEvent::onKnowledgebaseAttachmentUploaded()
Docblock: array article, array attachment, array uploaded_by.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | article | $article | arrayfrom docblock |
| 2 | attachment | $attachment | arrayfrom docblock |
| 3 | uploaded_by | $uploadedBy | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseAttachmentUploaded(), function ($article, $attachment, $uploadedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:attachment:uploaded ' . json_encode(['article' => $article, 'attachment' => $attachment, 'uploaded_by' => $uploadedBy]));
});KnowledgebaseEvent::onKnowledgebaseAttachmentsRetrieved()
Docblock: array article, array attachments.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | article | $article | arrayfrom docblock |
| 2 | attachments | $attachments | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseAttachmentsRetrieved(), function ($article, $attachments): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:attachments:retrieved ' . json_encode(['article' => $article, 'attachments' => $attachments]));
});KnowledgebaseEvent::onKnowledgebaseCategoriesRetrieved()
Docblock: array categories, array pagination, array search.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | categories | $categories | arrayfrom docblock |
| 2 | pagination | $pagination | array |
| 3 | search | $search | array |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseCategoriesRetrieved(), function ($categories, $pagination, $search): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:categories:retrieved ' . json_encode(['categories' => $categories, 'pagination' => $pagination, 'search' => $search]));
});KnowledgebaseEvent::onKnowledgebaseCategoryCreated()
Docblock: array category, array created_by.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | category | $category | arrayfrom docblock |
| 2 | created_by | $createdBy | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseCategoryCreated(), function ($category, $createdBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:category:created ' . json_encode(['category' => $category, 'created_by' => $createdBy]));
});KnowledgebaseEvent::onKnowledgebaseCategoryDeleted()
Docblock: array category, array deleted_by.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | category | $category | arrayfrom docblock |
| 2 | deleted_by | $deletedBy | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseCategoryDeleted(), function ($category, $deletedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:category:deleted ' . json_encode(['category' => $category, 'deleted_by' => $deletedBy]));
});KnowledgebaseEvent::onKnowledgebaseCategoryRetrieved()
Docblock: array category.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | category | $category | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseCategoryRetrieved(), function ($category): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:category:retrieved ' . json_encode(['category' => $category]));
});KnowledgebaseEvent::onKnowledgebaseCategoryUpdated()
Docblock: array category, array updated_by.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | category | $category | arrayfrom docblock |
| 2 | updated_by | $updatedBy | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseCategoryUpdated(), function ($category, $updatedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:category:updated ' . json_encode(['category' => $category, 'updated_by' => $updatedBy]));
});KnowledgebaseEvent::onKnowledgebaseIconUploaded()
Docblock: string filename, string url, array uploaded_by.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | url | $url | stringfrom docblock |
| 2 | filename | $filename | stringfrom docblock |
| 3 | uploaded_by | $uploadedBy | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseIconUploaded(), function ($url, $filename, $uploadedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:icon:uploaded ' . json_encode(['url' => $url, 'filename' => $filename, 'uploaded_by' => $uploadedBy]));
});KnowledgebaseEvent::onKnowledgebaseTagCreated()
Docblock: array article, array tag, array created_by.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | article | $article | arrayfrom docblock |
| 2 | tag | $tag | arrayfrom docblock |
| 3 | created_by | $createdBy | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseTagCreated(), function ($article, $tag, $createdBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:tag:created ' . json_encode(['article' => $article, 'tag' => $tag, 'created_by' => $createdBy]));
});KnowledgebaseEvent::onKnowledgebaseTagDeleted()
Docblock: array article, array tag, array deleted_by.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | article | $article | arrayfrom docblock |
| 2 | tag | $tag | arrayfrom docblock |
| 3 | deleted_by | $deletedBy | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseTagDeleted(), function ($article, $tag, $deletedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:tag:deleted ' . json_encode(['article' => $article, 'tag' => $tag, 'deleted_by' => $deletedBy]));
});KnowledgebaseEvent::onKnowledgebaseTagsRetrieved()
Docblock: array article, array tags.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | article | $article | arrayfrom docblock |
| 2 | tags | $tags | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onKnowledgebaseTagsRetrieved(), function ($article, $tags): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:knowledgebase:tags:retrieved ' . json_encode(['article' => $article, 'tags' => $tags]));
});KnowledgebaseEvent::onUserKnowledgebaseArticleRetrieved()
Docblock: array article, array attachments, array tags, array|null user.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | article | $article | arrayfrom docblock |
| 2 | attachments | $attachments | arrayfrom docblock |
| 3 | tags | $tags | arrayfrom docblock |
| 4 | user | $user | array|nullfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onUserKnowledgebaseArticleRetrieved(), function ($article, $attachments, $tags, $user): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:knowledgebase:article:retrieved ' . json_encode(['article' => $article, 'attachments' => $attachments, 'tags' => $tags, 'user' => $user]));
});KnowledgebaseEvent::onUserKnowledgebaseArticlesRetrieved()
Docblock: array articles, array pagination.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | articles | $articles | arrayfrom docblock |
| 2 | pagination | $pagination | array |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onUserKnowledgebaseArticlesRetrieved(), function ($articles, $pagination): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:knowledgebase:articles:retrieved ' . json_encode(['articles' => $articles, 'pagination' => $pagination]));
});KnowledgebaseEvent::onUserKnowledgebaseCategoriesRetrieved()
Docblock: array categories, array pagination.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | categories | $categories | arrayfrom docblock |
| 2 | pagination | $pagination | array |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onUserKnowledgebaseCategoriesRetrieved(), function ($categories, $pagination): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:knowledgebase:categories:retrieved ' . json_encode(['categories' => $categories, 'pagination' => $pagination]));
});KnowledgebaseEvent::onUserKnowledgebaseCategoryArticlesRetrieved()
Docblock: array category, array articles, array pagination.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | category | $category | arrayfrom docblock |
| 2 | articles | $articles | arrayfrom docblock |
| 3 | pagination | $pagination | array |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onUserKnowledgebaseCategoryArticlesRetrieved(), function ($category, $articles, $pagination): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:knowledgebase:category:articles:retrieved ' . json_encode(['category' => $category, 'articles' => $articles, 'pagination' => $pagination]));
});KnowledgebaseEvent::onUserKnowledgebaseCategoryRetrieved()
Docblock: array category.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | category | $category | arrayfrom docblock |
When it fires (1 site)
$event->on(KnowledgebaseEvent::onUserKnowledgebaseCategoryRetrieved(), function ($category): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:knowledgebase:category:retrieved ' . json_encode(['category' => $category]));
});