add_menu_item
add_menu_item_simple
build_comcode_menu
build_menu
copy_from_sitemap_to_new_menu
delete_menu
delete_menu_item
delete_menu_item_simple
edit_menu_item
export_menu_csv
import_menu_csv
menu_management_script
INCLUDE_SITEMAP_NO
INCLUDE_SITEMAP_OVER
INCLUDE_SITEMAP_UNDER
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, \ID_TEXT $theme_image_code= ''
, \SHORT_INTEGER $include_sitemap= 0
, \?AUTO_LINK $id= null
) : \AUTO_LINK
package | core_menus |
---|
\SHORT_TEXT
The name of the menu to add the item to.
integer
The relative order of this item on the menu.
\?AUTO_LINK
The menu item ID of the parent branch of the menu item (null: is on root).
\SHORT_TEXT
The caption.
\SHORT_TEXT
The URL (in entry point form).
\BINARY
Whether people who may not view the entry point do not see the link.
\SHORT_TEXT
Match-keys to identify what pages the item is shown on.
\BINARY
Whether it is an expanded branch.
\BINARY
Whether the link will open in a new window.
\SHORT_TEXT
The tooltip (blank: none).
\ID_TEXT
The theme image code.
\SHORT_INTEGER
An INCLUDESITEMAP* constant
\?AUTO_LINK
The ID (null: auto-increment)
\AUTO_LINK
The ID of the newly added menu item.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= ''
, \BINARY $new_window= 0
, \ID_TEXT $theme_image_code= ''
, \SHORT_INTEGER $include_sitemap= 0
, \?integer $order= null
) : \AUTO_LINK
package | core_menus |
---|
\SHORT_TEXT
The name of the menu to add the item to.
\?mixed
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
The caption.
\SHORT_TEXT
The URL (in entry point form).
\BINARY
Whether it is an expanded branch.
\BINARY
Whether people who may not view the entry point do not see the link.
boolean
Whether the caption is a language code.
\SHORT_TEXT
The tooltip (blank: none).
\BINARY
Whether the link will open in a new window.
\ID_TEXT
The theme image code.
\SHORT_INTEGER
An INCLUDESITEMAP* constant
\?integer
Order to use (null: automatic, after the ones that have it specified).
\AUTO_LINK
The ID of the newly added menu item.build_comcode_menu(\LONG_TEXT $comcode, \SHORT_TEXT $menu, \MEMBER $source_member, \ID_TEXT $type) : \Tempcode
package | core_menus |
---|
\LONG_TEXT
The contents of the Comcode menu tag
\SHORT_TEXT
An identifier for this menu (will be used as a unique ID by menu javascript code)
\MEMBER
The member the menu is being built as
\ID_TEXT
The menu type (determines what templates get used)
\Tempcode
The generated Tempcode of the menubuild_menu(\ID_TEXT $type, \SHORT_TEXT $menu, boolean $silent_failure = false
) : \Tempcode
package | core_menus |
---|
\ID_TEXT
The type of the menu (determines which templates to use)
\SHORT_TEXT
The menu identifier to use (may be the name of a stored menu, or syntax to load from the Sitemap)
boolean
Whether to silently return blank if the menu does not exist
\Tempcode
The generated Tempcode of the menucopy_from_sitemap_to_new_menu(\ID_TEXT $target_menu, \SHORT_TEXT $source)
package | core_menus |
---|
\ID_TEXT
The ID of the menu to save into.
\SHORT_TEXT
Sitemap details.
delete_menu(\ID_TEXT $menu_id)
delete_menu_item(\AUTO_LINK $id)
delete_menu_item_simple(\SHORT_TEXT $url)
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, \ID_TEXT $theme_image_code, \SHORT_INTEGER $include_sitemap)
package | core_menus |
---|
\AUTO_LINK
The ID of the menu item to edit.
\SHORT_TEXT
The name of the menu to add the item to.
integer
The relative order of this item on the menu.
\?AUTO_LINK
The menu item ID of the parent branch of the menu item (null: is on root).
\SHORT_TEXT
The caption.
\SHORT_TEXT
The URL (in entry point form).
\BINARY
Whether people who may not view the entry point do not see the link.
\SHORT_TEXT
Match-keys to identify what pages the item is shown on.
\BINARY
Whether it is an expanded branch.
\BINARY
Whether the link will open in a new window.
\SHORT_TEXT
The tooltip (blank: none).
\ID_TEXT
The theme image code.
\SHORT_INTEGER
An INCLUDESITEMAP* constant
export_menu_csv(\?PATH $file_path = null
)
package | core_menus |
---|
\?PATH
The path to the CSV file (null: uploads/website_specific/cms_menu_items.csv).
import_menu_csv(\?PATH $file_path = null
)
This function is intended for programmers, writing upgrade scripts for a custom site (dev>staging>live). Assumes CSV was generated with export_menu_csv.
package | core_menus |
---|
\?PATH
The path to the CSV file (null: uploads/website_specific/cms_menu_items.csv).