You are here

function hook_farm_dashboard_groups in farmOS 2.x

Defines farm dashboard groups.

Return value

array Returns an array of farm dashboard groups keyed by layout region.

1 function implements hook_farm_dashboard_groups()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

farm_ui_views_farm_dashboard_groups in modules/core/ui/views/farm_ui_views.module
Implements hook_farm_dashboard_groups().

File

modules/core/ui/dashboard/farm_ui_dashboard.api.php, line 66
Hooks provided by farm_ui_dashboard.

Code

function hook_farm_dashboard_groups() {
  return [
    // Returns an associate array keyed by the layout region.
    // Options are top, first, second, or bottom.
    'first' => [
      // Groups are defined as a render array keyed with a unique group
      // machine name.
      'my_group' => [
        // The type. Defaults to container.
        '#type' => 'details',
        // Optionally specify a title.
        '#title' => t('My group title'),
        // Optionally specify a weight for sorting.
        '#weight' => 100,
      ],
    ],
    'bottom' => [],
  ];
}