/sources/menus2.php

Description
Functions
add_menu_item (line 142)

Add a menu item.

  • return: The ID of the newly added menu item.
AUTO_LINK add_menu_item (SHORT_TEXT $menu, integer $order, ?AUTO_LINK $parent, SHORT_TEXT $caption, SHORT_TEXT $url, BINARY $check_permissions, SHORT_TEXT $page_only, BINARY $expanded, BINARY $new_window, SHORT_TEXT $caption_long)
  • SHORT_TEXT $menu: The name of the menu to add the item to.
  • integer $order: The relative order of this item on the menu.
  • ?AUTO_LINK $parent: The menu item ID of the parent branch of the menu item (NULL: is on root).
  • SHORT_TEXT $caption: The caption.
  • SHORT_TEXT $url: The URL (in entry point form).
  • BINARY $check_permissions: Whether people who may not view the entry point do not see the link.
  • SHORT_TEXT $page_only: Match-keys to identify what pages the item is shown on.
  • BINARY $expanded: Whether it is an expanded branch.
  • BINARY $new_window: Whether the link will open in a new window.
  • SHORT_TEXT $caption_long: The tooltip (blank: none).
add_menu_item_simple (line 93)

Add a menu item, without giving tedious/unnecessary detail.

  • return: The ID of the newly added menu item.
AUTO_LINK add_menu_item_simple (SHORT_TEXT $menu, ?mixed $parent, SHORT_TEXT $caption, [SHORT_TEXT $url = ''], [BINARY $expanded = 0], [BINARY $check_permissions = 0], [boolean $dereference_caption = true], [SHORT_TEXT $caption_long = ''])
  • SHORT_TEXT $menu: The name of the menu to add the item to.
  • ?mixed $parent: The menu item ID of the parent branch of the menu item (AUTO_LINK) / the URL of something else on the same menu (URLPATH) (NULL: is on root).
  • SHORT_TEXT $caption: The caption.
  • SHORT_TEXT $url: The URL (in entry point form).
  • BINARY $expanded: Whether it is an expanded branch.
  • BINARY $check_permissions: Whether people who may not view the entry point do not see the link.
  • boolean $dereference_caption: Whether the caption is a language code.
  • SHORT_TEXT $caption_long: The tooltip (blank: none).
delete_menu_item (line 204)

Delete a menu item.

void delete_menu_item (AUTO_LINK $id)
  • AUTO_LINK $id: The ID of the menu item to delete.
delete_menu_item_simple (line 118)

Delete a menu item, without giving tedious/unnecessary detail.

void delete_menu_item_simple (SHORT_TEXT $url)
  • SHORT_TEXT $url: The URL (in entry point form).
edit_menu_item (line 178)

Edit a menu item.

void edit_menu_item (AUTO_LINK $id, SHORT_TEXT $menu, integer $order, ?AUTO_LINK $parent, SHORT_TEXT $caption, SHORT_TEXT $url, BINARY $check_permissions, SHORT_TEXT $page_only, BINARY $expanded, BINARY $new_window, SHORT_TEXT $caption_long)
  • AUTO_LINK $id: The ID of the menu item to edit.
  • SHORT_TEXT $menu: The name of the menu to add the item to.
  • integer $order: The relative order of this item on the menu.
  • ?AUTO_LINK $parent: The menu item ID of the parent branch of the menu item (NULL: is on root).
  • SHORT_TEXT $caption: The caption.
  • SHORT_TEXT $url: The URL (in entry point form).
  • BINARY $check_permissions: Whether people who may not view the entry point do not see the link.
  • SHORT_TEXT $page_only: Match-keys to identify what pages the item is shown on.
  • BINARY $expanded: Whether it is an expanded branch.
  • BINARY $new_window: Whether the link will open in a new window.
  • SHORT_TEXT $caption_long: The tooltip (blank: none).
init__menus2 (line 24)

Standard code module initialisation function.

void init__menus2 ()
menu_management_script (line 33)

Move a menu branch.

void menu_management_script ()

Documentation generated on Sun, 02 Jan 2011 23:17:48 +0000 by phpDocumentor 1.4.3