diff options
author | diosmosis <benakamoorthi@fastmail.fm> | 2013-10-25 18:49:33 +0400 |
---|---|---|
committer | diosmosis <benakamoorthi@fastmail.fm> | 2013-10-25 18:49:42 +0400 |
commit | 145fcb57614297bc9be5cbb9597c0820416640be (patch) | |
tree | 616e20edb4eb8665f67444c739347930789dbaf1 /core/WidgetsList.php | |
parent | 6d4d87e81984e68a7f792ea964e9464a9d984231 (diff) |
Refs #4200 revised event docs for core/* files.
Diffstat (limited to 'core/WidgetsList.php')
-rw-r--r-- | core/WidgetsList.php | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/core/WidgetsList.php b/core/WidgetsList.php index 08dae47210..91f753b389 100644 --- a/core/WidgetsList.php +++ b/core/WidgetsList.php @@ -74,11 +74,14 @@ class WidgetsList self::$hookCalled = true; /** - * This event is triggered to collect all available widgets. Subscribe to this event if you want to create - * one or more custom widgets. Just define the name of your widgets as well as a controller and an action - * that should be executed once your widget is requested. + * Triggered once when the widget list is first requested. Collects all available widgets. + * + * Subscribe to this event to make your plugin's reports or other controller actions available + * as dashboard widgets. Event handlers should call the WidgetsList::add method for each + * new dashboard widget. * - * Example: + * **Example** + * * ``` * public function addWidgets() * { |