Skip to documentation content

Menu Item

On this page

    The menu item object and its properties.

    {{ menu_item }}

    Properties
    Name Type Description
    object_type string Will always be menu_item
    is_valid boolean True if this references a published menu_item
    guid string The unique identifier for this menu_item
    value string Contains the same value as guid
    menu_guid string The unique identifier of the related menu
    menu {{ menu }} Reference to the related menu object
    parent_menu_item_guid string The unique identifier of the parent menu_item, if applicable
    parent_menu_item {{ menu_item }} Reference to the parent menu_item object, if applicable
    name {{ text }} The lable used to display this menu_item in the navigation menu
    href {{ url }} Destination URL to navigate to when clicked
    open_in_new_tab boolean If true, the link should open in a new browser tab/window
    description {{ textarea }} Short descriptive text to display with this menu_item
    content {{ html }} HTML content to display with this menu_item
    image_guid string The unique identifier of the related image
    image {{ image }} Reference to the related image object
    depth integer Hierarchy depth of this item within its parent structure, where top-level menu items have a depth of 1, their children have a depth of 2, and so on
    order integer Display order of this item relative to its siblings
    items {{ menu_items }} A list containing all of the menu items that are direct children of the current menu item
    field_id string The identifier for this field
    label string The label for this field
    output string The default output that the menu_item 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 menu items themselves

    {{ menu_items }}

    Contains multiple menu_items.

    Properties
    Name Type Description
    object_type string Will always be menu_items
    is_valid boolean True if this contains at least one published menu_item
    output string 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
    prepended list List containing any prepended menu_items.
    fetched list List containing all of the menu_items that were fetched from the database (as opposed to prepended or appended).
    appended list List containing any appended menu_items.
    appended_unique list List containing any appended menu_items excluding any menu_items that are in either the list of prepended or fetched menu_items.
    items list List containing all of the combined menu_items 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 menu_items specified.
    size integer The total number of menu_items 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 menu_items 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_item will be included.
    limit integer The maximum number of items that were allowed to be in the list of fetched menu_items. May be 0 in some cases (such as when when there are no fetched menu_items.
    start integer The 1-based index of the first item in the list of fetched menu_items.
    page integer The 1-based index of the paginated results returned in the list of fetched menu_items, 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 menu_items
    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_item %}

    {% menu_item output_to_template? [[var, set, or assign]? variable]? output_to_template? = value %}
    Parameters
    output_to_template optionalflag
    If included the {% menu_item %} 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_item %} is stored on. "var" is the default behavior.
    variable_name optionalvariable
    Specify a variable name in order to save this menu_item to a variable. If not specified, it will be output to the template instead.
    value requiredexpression
    Should evaluate to an object of type menu_item, or the name or guid of one. May use liquid filters.

    Fetches a single {{ menu_item }}.

    {% menu_items %}

    {% menu_items output_to_template? [[var, set, or assign]? variable]? output_to_template? = arguments %}
    Parameters
    output_to_template optionalflag
    If included the {% menu_items %} 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_items %} 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_item, a list of menu_items, or the name or guid of one menu_item, to be included at the beginning of the menu_items list.
    append optionallist
    May be a single menu_item, a list of menu_items, or the name or guid of one menu_item, to be included at the end of the menu_items list.
    exclude optionallist
    May be a single menu_item, a list of menu_items, or the name or guid of one menu_item that should NOT be included in the fetched results. Has no effect on prepended or appended menu_items.
    exclude_prepended optionalboolean
    True to specifically exclude all prepended menu_items 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 menu_items 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 menu_items as needed. Note that this may also impact both the "page" and "total_pages" values in the resulting menu_items. In order to use pagination with a list loaded using "max_size" use "start" instead of "page" and "limit".
    start optionalinteger
    Set the 1-based index of the first menu_item to fetch.
    page optionalinteger
    Used to automatically calculate the first menu_item 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 menu_items 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 menu_items. Options include:
    • date_created: the date each menu_item 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 {{ menu_items }}.