Menu

Menu

{{ menu }}

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this references a published menu
guid String The unique identifier for this menu
value String Contains the same value as guid
name text The name of this menu, primarily used for identification and organization
items menu_items A list containing all of the top-level menu_items in the current menu
field_id String The identifier for this field
label String The label for this field
output String The default output that the menu produces when output directly to the template. The default output may change at any time. Template developers should avoid using this and should handle the output of menus themselves

{{ menus }}

Contains multiple menus.

Name Type Description
object_type String Will always be datastore_item
is_valid Boolean True if this contains at least one published menu
output String The default output that the menus will produce when it is output directly to the template - using the "output_in_list" property of each menu in the items list
prepended list List containing any prepended menus.
fetched list List containing all of the menus that were fetched from the database (as opposed to prepended or appended).
appended list List containing any appended menus.
appended_unique list List containing any appended menus excluding any menus that are in either the list of prepended or fetched menus.
items list List containing all of the combined menus from the prepended, fetched, and appended lists. If unique is true, this list will not contain any duplicates. If max_size is set, this list will not contain more than the number of menus specified.
size Integer The total number of menus in the items list, including prepended, fetched, and appended lists, and respecting the unique and max_size properties.
max_size Integer If set, this is the maximum number of items that will be returned in the items list and the maximum number of items that will be included when this menus object is enumerated as a list. When not set, this value will be 0.
unique Boolean When true, the items list will not contain any duplicates. Only the first instance of each menu will be included.
limit Integer The maximum number of items that were allowed to be in the list of fetched menus. May be 0 in some cases (such as when when there are no fetched menus.
start Integer The 1-based index of the first item in the list of fetched menus.
page Integer The 1-based index of the paginated results returned in the list of fetched menus, which is calculated from the start and limit parameters. Useful for paginated results.
total_count Integer The 1-based index of the first item in the list of fetched menus
total_pages Integer

{% menu %}

{% menu output_to_template? [var, set, or assign]? variable? output_to_template? = value %}

{% menu
output_to_template
 
If included the menu will be output directly to the template.
var, set, or assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this menu is stored on. "var" is the default behavior.
variable_name
 
Specify a variable name in order to save this menu to a variable. If not specified, it will be output to the template instead.
output_to_template
 
If included the menu will be output directly to the template.
=
value
 
Should evaluate to a menu object, or the name or guid of a menu May use liquid filters.
%}
Fetches a single menu.

Examples

Fetching Menu Items

Copy
{% menu var mainMenu = "Main" %}
{% for item in mainMenu.items %}
<a href="{{item.href}}">{{item.title}}</a>
{% endfor %}

{% menus %}

{% menus output_to_template? [var, set, or assign]? variable? output_to_template? = arguments %}

{% menus
output_to_template
 
If included the menus will be output directly to the template.
var, set, or assign
 
Optional. Specify either "var", "set" or "assign" to change which scope this menus is stored on. "var" is the default behavior.
variable
output_to_template
 
If included the menus will be output directly to the template.
=
arguments
 
Key:value pairs. May use the variable arguments syntax.
%}

arguments

prepend
 
May be a single menu, a list of menus, or the name or guid of a menu to be be included at the beginning of the menus.
append
 
May be a single menu, a list of menus, or the name or guid of a menu to be be included at the end of the menus.
exclude
 
May be a single menu, a list of menus, or the name or guid of a menu that should NOT be included in the fetched results. Has no affect on prepended or appended menus.
exclude_prepended
 
True to specifically exclude all prepended menus from the fetched results. If "unique:true" is specified this is the default behavior, although you may also specify "exclude_prepended:false" to allow any prepended items to be fetched along with other results anyway.
exclude_appended
 
True to specifically exclude all appended menus from the fetched results. This is false by default - even if "unique:true" is specified - so that results are returned in the proper order.
unique
 
True to remove duplicates from each of the resulting lists (prepended, fetched, appended, and items), although there may be duplicates between the prepended, fetched, and appended lists. The "items" list will include objects in the order in which they appear - with prepended items first, then fetched items, then appended items.
max_size
 
The maximum number of items to be included in the "items" list. If there are any prepended or appended items, this will automatically lower the "limit" to only fetch as many menus as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting menus. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
date_created_start
 
Only include menus with date_created greater than or equal to date_created_start. Remember that date_created will typically be the date that the menu was first published.
date_created_end
 
Only include menus with date_created less than or equal to date_created_end. Remember that date_created will typically be the date that the menu was first published.
start
 
Set the 1-based index of the first menu to fetch.
page
 
Used to automatically calculate the first menu to fetch based on both the "limit" and the 1-based "page" value. Defaults to 1, but is ignored if "start" is set.
limit
 
The maximum number of menus to fetch. Defaults to 10. Note that if "max_size" is defined, then "limit" may be automatically lowered even if specified separately.
sort_by
 
Specify which property to sort the results by. Has no affect on prepended or appended menus. Options include:
  • date_created: the date each menus was first published. Unpublishing and republishing a menus resets date_created to the current date.
  • random: results will be returned in a random order, which prevents the page from being fast-cached. Setting cache_random:true overrides this behavior and allows the page to be fast-cached anyway.
  • name
  • title
  • url
  • browser_title
sort_direction
 
asc or desc.
cache_random
 
True to allow the results to be cached when sort_by is "random".
Fetches a list of menus.