function hook_checklistapi_checklist_info in Checklist API 7

Same name and namespace in other branches

8 checklistapi.api.php \hook_checklistapi_checklist_info()

Define all checklists provided by the module.

Any number of checklists can be defined in an implementation of this hook. Checklist API will register menu items and create permissions for each one.

Return value

array An array of checklist definitions. Each definition is keyed by an arbitrary unique identifier. The corresponding multidimensional array describing the checklist may contain the following key-value pairs:

#title: The title of the checklist.
#path: The Drupal path where the checklist will be accessed.
#description: (optional) A brief description of the checklist for its corresponding menu item.
#help: (optional) User help to be displayed in the "System help" block via hook_help().
#menu_name: (optional) The machine name of a menu to place the checklist into (e.g. "main-menu" or "navigation"). If this is omitted, Drupal will try to infer the correct menu placement from the specified path.
#weight: (optional) A floating point number used to sort the list of checklists before being output. Lower numbers appear before higher numbers.
Any number of arrays representing groups of items, to be presented as vertical tabs. Each group is keyed by an arbitrary identifier, unique in the scope of the checklist. The corresponding multimensional array describing the group may contain the following key-value pairs:
- #title: The title of the group, used as the vertical tab label.
- #description: (optional) A description of the group.
- #weight: (optional) A floating point number used to sort the list of groups before being output. Lower numbers appear before higher numbers.
- Any number of arrays representing checklist items. Each item is keyed by an arbitrary identifier, unique in the scope of the checklist. The corresponding multimensional array describing the item may contain the following key-value pairs:
  - #title: The title of the item.
  - #description: (optional) A description of the item, for display beneath the title.
  - #default_value: (optional) The default checked state of the item--TRUE for checked or FALSE for unchecked. Defaults to FALSE. This is useful for automatically checking items that can be programmatically tested (e.g. a module is installed or a variable has a certain value).
  - #weight: (optional) A floating point number used to sort the list of items before being output. Lower numbers appear before higher numbers.
  - Any number of arrays representing links. Each link is keyed by an arbitrary unique identifier. The corresponding multimensional array describing the link may contain the following key-value pairs:
    - #text: The link text.
    - #path: The link path.
    - #options: (optional) An associative array of additional options used by the l() function.
    - #weight: (optional) A floating point number used to sort the list of items before being output. Lower numbers appear before higher numbers.

For a working example, see checklistapi_example.module.

File

./checklistapi.api.php, line 74: Hooks provided by the Checklist API module.

Code

function hook_checklistapi_checklist_info() {
  $definitions = array();
  $definitions['example_checklist'] = array(
    '#title' => t('Example checklist'),
    '#path' => 'example-checklist',
    '#description' => t('An example checklist.'),
    '#help' => t('<p>This is an example checklist.</p>'),
    'example_group' => array(
      '#title' => t('Example group'),
      '#description' => t('<p>Here are some example items.</p>'),
      'example_item_1' => array(
        '#title' => t('Example item 1'),
        'example_link' => array(
          '#text' => t('Example.com'),
          '#path' => 'http://www.example.com/',
        ),
      ),
      'example_item_2' => array(
        '#title' => t('Example item 2'),
      ),
    ),
  );
  return $definitions;
}

You are here

function hook_checklistapi_checklist_info in Checklist API 7

Return value

See also

File

Code

API Navigation