{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Admin Dashboard Widgets","description":"Developer documentation for the WHMCS API — the","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"admin-dashboard-widgets","__idx":0},"children":["Admin Dashboard Widgets"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Admin Dashboard Widgets are displayed on the admin area homepage."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["They allow you to provide convenient access to key information and functionality from your module within the admin homepage dashboard."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Below is an example of how a dashboard widget is defined."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"<?php\n\nadd_hook('AdminHomeWidgets', 1, function() {\n    return new HelloWorldWidget();\n});\n\n/**\n * Hello World Widget.\n */\nclass HelloWorldWidget extends \\WHMCS\\Module\\AbstractWidget\n{\n    protected $title = 'Hello World';\n    protected $description = '';\n    protected $weight = 150;\n    protected $columns = 1;\n    protected $cache = false;\n    protected $cacheExpiry = 120;\n    protected $requiredPermission = '';\n\n    public function getData()\n    {\n        return array();\n    }\n\n    public function generateOutput($data)\n    {\n        return <<<EOF\n<div class=\"widget-content-padded\">\n    Hello World!\n</div>\nEOF;\n    }\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["More information on the AbstractWidget class used in the above example can be found at http://docs.whmcs.com/classes/7.1/WHMCS/Module/AbstractWidget.html"]}]},"headings":[{"value":"Admin Dashboard Widgets","id":"admin-dashboard-widgets","depth":1}],"frontmatter":{"title":"Admin Dashboard Widgets","seo":{"title":"Admin Dashboard Widgets"}},"lastModified":"2026-08-03T17:00:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/provisioning-modules/admin-dashboard-widgets","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}