[Summary view] [Print] [Text view]

   1  <?php
   2  // $Id: menu_block.api.php,v 1.2 2010/03/12 17:30:00 johnalbin Exp $
   3  
   4  /**
   5   * @file
   6   * Hooks provided by the Menu Block module.
   7   */
   8  
   9  /**
  10   * @addtogroup hooks
  11   * @{
  12   */
  13  
  14  /**
  15   * Alter the menu tree and its configuration before the tree is rendered.
  16   *
  17   * @param $tree
  18   *   An array containing the unrendered menu tree.
  19   * @param $config
  20   *   An array containing the configuration of the tree.
  21   */
  22  function hook_menu_block_tree_alter(&$tree, &$config) {
  23  }
  24  
  25  /**
  26   * Return a list of menus to use with the menu_block module.
  27   *
  28   * @return
  29   *   An array containing the menus' machine names as keys with their menu titles
  30   *   as values.
  31   */
  32  function hook_get_menus() {
  33    $menus = array();
  34    // For each menu, add the following information:
  35    $menus['menu_name'] = 'menu title';
  36  
  37    return $menus;
  38  }
  39  
  40  /**
  41   * @} End of "addtogroup hooks".
  42   */