Field | Type | Description |
object_type | string | "menu_item" |
is_valid | True|False | True if this references a menu_item or false if the menu_item is null |
guid | guid | |
menu_guid | text_field | |
menu | menu | |
parent_menu_item_guid | text_field | |
parent_menu_item | menu_item | |
name | text_field | |
href | url_field | |
open_in_new_tab | boolean | |
description | textarea_field | |
content | html_field | |
image_guid | text_field | |
image | image | |
depth | number | |
order | number | |
items | menu_items | A list containing all of the menu items that are direct children of the current menu item. |
value | string | Synonymn for guid |
output | html | The default output that the menu_item produces when output directly to the template. |
output_in_list | html | The default output that the menu_item produces when output directly to the template as part of a list. |
Contains multiple menu_items.
Field | Type | Description |
object_type | string | "menu_items" |
is_valid | true/false | true if this contains at least one menu_item |
prepended | list of menu_items | menu_items that will be listed at the beginning of the items list |
fetched | list of menu_items | The primary list of menu_items to be included in the items list |
appended | list of menu_items | menu_items that will be listed at the end of the items list |
appended_unique | list of menu_items | menu_items that will be listed at the end of the items list, excluding any menu_items that are already included in either the prepended or fetched lists |
items | list of menu_items | The full list of menu_items in the proper order and uniqueness, including prepended, fetched, and appended menu_items |
size | number | The total number of items in the list of items, including prepended, fetched, and appended menu_items |
limit | number | The maximum number of menu_items that could have been fetched dynamically from the database |
start | number | The 1-based index of the first menu_item that was (or would have been) dynamically fetched from the database |
page | number | The 1-based index of the first "page" of menu_items that could have been fetched dynamically from the database - as determined by the start and limit properties |
total_count | number | The total number of menu_items in the database that matched the provided filter parameters when fetching the list of fetched menu_items |
total_pages | number | The total number of "pages" of results that matched the provided filter parameters when fetching the list of fetched menu_items - as determined by the total_count and limit properties |
output | html | The default output that the menu_items will produce when it is output directly to the template - using the "output_in_list" property of each menu_item in the items list |
Fetching Menu Items
CopyFetch a single menu_item.
{% menu_item[var|set|assign] new_variable_nameSpecify a variable name in order to save the menu_item to a variable. If not specified the menu_item will be output to the template instead. The variable will be saved using the "var" behavior unless "set" or "assign" are specified.output_to_templateIf included, the menu_item will be output directly to the template.=menu_item|guid|string%}
Fetch a list of menu_items.
{% menu_items[var|set|assign] new_variable_nameSpecify a variable name in order to save the results to a variable. If not specified the results will be output to the template instead. The variable will be saved using the "var" behavior unless "set" or "assign" are specified.output_to_templateIf included, the results will be output directly to the template.=prepend:menu_item|menu_items|guid|stringPrepend the specified menu_items at the beginning of the items list. All prepended input will be returned in the same order that it is input.append:menu_item|menu_items|guid|stringAppend the specified menu_items at the end of the items list. All appended input will be returned in the same order that it is input.unique:trueIf set to true, each of the resulting lists (prepended, appended, and items) will be unique, although there may be duplicates between the prepended, and appended lists. The "items" list will include objects in the order in which they appear - with prepended items first then appended items.max_size:25If specified, then the "items" list will only include up to the specified number of menu_items%}