Skip to documentation content

Menu

On this page

    The menu object and methods for site menus.

    {{ menu }}

    Properties
    Name Type Description
    object_type string Will always be menu
    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
    Example Fetch and display menu itemsFetch menu items (e.g. from a datastore or menu object) and output them in a list or nav.
    Liquid
    {%- menu var mainMenu = "Main" -%}
{%- for item in mainMenu.items -%}
	<a href="{{item.href}}">{{item.title}}</a>
{%- endfor -%}

    {{ menus }}

    Contains multiple menus.

    Properties
    Name Type Description
    object_type string Will always be menus
    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 If any items were fetched from the database, total_pages will contain the number of paginated result pages in the database for the provided arguments. This may also be calculated using the total_count and limit properties.

    {% menu %}

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

    Fetches a single {{ menu }}.

    Example Fetch and display menu itemsFetch menu items (e.g. from a datastore or menu object) and output them in a list or nav.
    Liquid
    {%- 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 %}
    Parameters
    output_to_template optionalflag
    If included the {% menus %} will be output directly to the template.
    var, set, or assign optionalkeyword
    Optional. Specify either "var", "set" or "assign" to change which scope this {% menus %} is stored on. "var" is the default behavior.
    variable optionalvariable
    arguments requiredcollection
    Key:value pairs. May use the variable arguments syntax.

    Options

    prepend optionallist
    May be a single menu, a list of menus, or the name or guid of one menu, to be included at the beginning of the menus list.
    append optionallist
    May be a single menu, a list of menus, or the name or guid of one menu, to be included at the end of the menus list.
    exclude optionallist
    May be a single menu, a list of menus, or the name or guid of one menu that should NOT be included in the fetched results. Has no effect on prepended or appended menus.
    exclude_prepended optionalboolean
    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 optionalboolean
    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 optionalboolean
    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 optionalinteger
    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 optionalvalue
    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 optionalvalue
    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 optionalinteger
    Set the 1-based index of the first menu to fetch.
    page optionalinteger
    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 optionalinteger
    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 optionalstring
    Specify which property to sort the results by. Has no effect on prepended or appended menus. Options include:
    • date_created: the date each menu was first published. Unpublishing and republishing one 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 optionalstring
    asc or desc.
    cache_random optionalboolean
    True to allow the results to be cached when sort_by is "random".

    Fetches a list of {{ menus }}.