farm_dashboard.api.php in farmOS 7

Hooks provided by farm_dashboard.

This file contains no working PHP code; it exists to provide additional documentation for doxygen as well as to document hooks in the standard Drupal manner.

File

modules/farm/farm_dashboard/farm_dashboard.api.php

<?php

/**
 * @file
 * Hooks provided by farm_dashboard.
 *
 * This file contains no working PHP code; it exists to provide additional
 * documentation for doxygen as well as to document hooks in the standard
 * Drupal manner.
 */

/**
 * @defgroup farm_dashboard Farm dashboard module integrations.
 *
 * Module integrations with the farm_dashboard module.
 */

/**
 * @defgroup farm_dashboard_hooks Farm dashboard's hooks
 * @{
 * Hooks that can be implemented by other modules in order to extend farm_dashboard.
 */

/**
 * Defines farm dashboard panes.
 *
 * @return array
 *   Returns an array of farm dashboard pane configurations.
 */
function hook_farm_dashboard_panes() {
  return array(
    // A pane is defined with an associative array, keyed with a unique pane
    // machine name.
    'my_pane' => array(
      // Specify a 'view' and 'view_display ID' to automatically load a View.
      // This will take precedence over 'title' and 'callback' below.
      'view' => 'my_view',
      'view_display_id' => 'block_1',
      // Specify the title and callback function that produces output.
      'title' => t('My pane title'),
      'callback' => 'my_callback_function',
      // Optionally specify a group and weight for display sorting.
      'group' => 'custom_group',
      'weight' => 100,
    ),
  );
}

/**
 * @}
 */

Functions

Name	Description
hook_farm_dashboard_panes	Defines farm dashboard panes.