Skip to content

Widgets

Currently available in beta

Admin Dashboard is currently available in beta, which means some of the features, specifications, and details provided herein are subject to change. We recommend checking back regularly for the most up-to-date information and viewing our roadmap in regard to the general availability release.

When talking about admin dashboard widgets, these fall into one of two categories:

Widget Types

Widget types are generic, reusable components that determine the functionality and appearance of a dashboard widget. They are defined in code (using an XML file and PHP class) and act as a sort of template for a particular type of dashboard content. Each widget type can have many widget instances.

A list of available widget types can be found here.

Creating Widget Types

Creating a dashboard widget requires two steps:

  1. Defining the widget via XML
  2. Implementing the widget behaviours in PHP

Widget Instances

Widget instances are a particular instantiation of a widget type - complete with specific configuration values chosen by the admin user during creation. They are stored in the database and are what the admin user sees rendered on their dashboard. Each widget instance relates to a single widget type.

More information about widget instances can be found here.