Purchase a license: $65

Purchases made through PayPal. Full refunds available within 30 days.

EE2 + 1.7.X compatible

Questions + support for purchased licenses: support@buildwithstructure.com

Tags

These tags are for EE2 only and require Structure 3.0+. View EE1 tags and documentation »

Breadcrumbs

{exp:structure:breadcrumb}

The breadcrumb tag displays in a standardized format and has a few parameters to control its output. Format = Path » To » Current » Page » Here _Several parameters have been contributed by Aaron Gustafson @ easy-designs.net (Thanks, Aaron!)_

Custom Title Field

channel:title="channel:custom_field|channel_2:custom_field_2", defaults to entry title (when unset)

Uses a specific custom field per channel instead of the default title variable.

Home Link

home_link="/fr"

Used to change the Home link to an alternate URL. Useful for multi language sites.

Include Here / Current Page

inc_here="yes|no", defaults to yes

Include Home

inc_home="yes|no", defaults to yes

Include Separator

inc_separator="yes|no", defaults to yes

Last Class

add_last_class="yes|no", defaults to yes

Adds a class of last to your trail

Page Title Instead of Here

here_as_title="yes|no", defaults to no

Rename Home

rename_home="Casa"

Used to change the Home link text to an alternate word. Useful for multi language sites.

Separator

separator=":", defaults to »

Spaces are automatically added around the element for you.

Show a Specific Breadcrumb

uri="/tags/breadcrumbs/"

Useful for search results pages to show where item was found (Example: "Found in About » News")

Wrap Each

wrap_each="li"

Do not include < or > around tag, Structure writes it for you.

Wrap Here

wrap_here="em"

Do not include < or > around tag, Structure writes it for you.

Wrap Separator

wrap_separator="span"

Do not include < or > around tag, Structure writes it for you.

Entries

{exp:structure:entries}

A replacement for the channel tag to call a parent's children. You can use all of the same variables as a channel tag within it. See Structure Entries examples.

Parent ID

parent_id

Assign which children to show within the entires tag. 0 shows top level.

Include Hidden

include_hidden, defaults to no

Shows pages marked as hidden.

First Child Redirect

{exp:structure:first_child_redirect}

Add this tag (and only this tag) to a template and it will redirect you to the first child.

No Parameters

Global Variables

{structure:variable:value}

A library of global variables related to the current page. Variables will not work inside snippets.

{structure:child_listing:channel_id}

The channel ID of a channel attached as a listing

{structure:child_listing:short_name}

The channel short name of a channel attached as a listing

{structure:is:page}

Returns 1 or blank for the current page

Detects if the current page is a page type of "Page" in Structure » Channel Settings

{structure:is:listing}

Returns 1 or blank for the current page

Detects if the current page is a listing detail page

{structure:is:listing:parent}

Returns 1 or blank for the current page

Detects if the current page is a page type of "Listing" in Structure » Channel Settings (has a listing attached to it)

{structure:page:entry_id}

The current page's "entry_id" variable

{structure:page:title}

The same as EE's native "title" variable

{structure:page_title_for:XXX}

The title of a specific entry using the entry ID

{structure:page:slug}

The segment for the current page

{structure:page_slug_for:XXX}

The slug of a specific entry using the entry ID

{structure:page:uri}

The same as EE's native "page_uri" variable

{structure:page_uri_for:XXX}

The URI of a specific entry using the entry ID

{structure:page:url}

The same as EE's native "page_url" variable

{structure:page_url_for:XXX}

The URL of a specific entry using the entry ID

{structure:child_ids}

Returns IDs of children for the current page.

Example: "24" or "4|8|5|16|23|42"

{structure:child_ids_for:XXX}

Returns IDs of children for a specific page.

{structure:parent:entry_id}

The entry ID of the current page's parent

{structure:parent:title}

The "title" variable of the current page's parent

{structure:parent:slug}

The single segment of the URL/URI of the current page's parent

{structure:parent:uri}

The full URI of the current page's parent

{structure:parent:url}

The full URL of the current page's parent

{structure:sibling_ids}

Returns the sibling IDs of the current page.

Example: "24" or "4|8|5|16|23|42"

{structure:top:entry_id}

The entry ID of the current page's top level parent

{structure:top:title}

The "title" variable of the current page's top level parent

{structure:top:slug}

The single segment of the URL/URI of the current page's top level parent

{structure:top:uri}

The full URI of the current page's top level parent

{structure:top:url}

The full URL of the current page's top level parent

Navigation

{exp:structure:nav}

The nav tag is intended for all navigation within your Structure site and will automatically add class="here" to the current page’s <li> and class="last" to the last <li>. Examples of each parameters usage can be found in our navigation documentation examples.

Add Level Classes

add_level_classes="yes|no", defaults to no

Displays class="level_1", class="level_2", etc on each li

Add Span

add_span="yes|no", defaults to no

Adds a span tag around each individual navigation element within the a tag.

Add Unique IDs

add_unique_ids="yes|entry_id|no", defaults to no

Adds a unique ID to the a tag using the top parent slug, default seperator and pageslug or entry ID.

CSS Class

css_class="sub_navigation"

Assigns a class to the ul.

CSS ID

css_id="sub_navigation"

Assigns an ID to the ul. You can add "none" to optionally display no ID.

Current Class

current_class="active", defaults to here

Change the class name added to the current page's li tag.

Custom Title Field

channel:title="channel_name:field_name|another_channel:another_field", defaults to entry title (when unset)

Uses a specific custom field per channel instead of the default title variable.

Exclude

exclude="24" or "4|8|5|16|23|42"

The parameter "exclude=" can be used to hide any single or multiple user defined entry numbers using the pipe character. All children under a specified ID will be hidden as well.

Has Children Class

has_children_class="yes|no", defaults to no

Adds a class to pages that have children as an additional tiling hook.

Include

include="24" or "4|8|5|16|23|42"

The parameter "include=" can be used to selectively show specific pages from the same level.

Include ul

include_ul="yes|no", defaults to yes

Conditionally output the surrounding ul tag.

Max Depth

max_depth="2"

Only show up to XX levels deep from the current start_from parameter. Useful to hide pages under a desired level (like thank you or confirmation pages) or for main navigation.

Override Hidden State

override_hidden_state="yes", defaults to no

Show all pages regardless of whether they're set to be hidden from the nav.

Overview (Parent) Link

show_overview="yes", defaults to no

Shows a link at the top of your navigation that links to the current top level page. Use with rename_overview to change the title.

Recursive Overview

recursive_overview="no|yes", defaults to no

Show the overview link on every level, instead of only the first one. Works with show_overview.

Rename Overview (Parent) Link

rename_overview="Overview|Whatever|title", defaults to "Overview"

Rename the link at the top of your navigation that links to the current top level page. Use with show_overview to reveal. "title" uses the page's title field.

Start From

start_from="/about" or start_from ="/{segment_1}/{segment_2}"

Used to indicate where to begin revealing children. The "start_from" parameter must be a full URI or URL.

Strict Start From

strict_start_from="yes"

Will NOT return a nav if there is no match to your "start_from" param. Normally, if there is no match, Structure returns the full nav starting from the base of your website.

Show Depth

show_depth="2"

Reveals XX levels deep for ALL children pages of the current start_from parameter.

Show Expired

show_expired="yes|no", defaults to no

Allows you to show or not show expired entries within the navigation tree.

Show Future

show_future_entries="yes|no", defaults to no

Allows you to show or not show future entries within the navigation tree.

Site URL

site_url="yes|no", defaults to no

Include the absolute site URL in your nav links instead of relative links.

Status

status="Radical|Sweet" or status="not Bogus|Bad", defaults to Open

Restrict pages by status, using normal EE syntax. When prefixed with "not" all entries except those are available.

Navigation Advanced

{exp:structure:nav_advanced} {/exp:structure:nav_advanced}

Structure Nav (a third-party plugin by Rob Sanchez) has been officially rolled into Structure. You can use the tag pair just as you did with the original Structure Nav! Examples can be found in our navigation documentation examples.

Same parameters as exp:structure:nav

Navigation Basic

{exp:structure:nav_basic} {/exp:structure:nav_basic}

Structure Nav (a third-party plugin by Rob Sanchez) has been officially rolled into Structure. You can use the tag pair just as you did with the original Structure Nav! Examples can be found in our navigation documentation examples.

Same parameters as exp:structure:nav

SAEF Select

{exp:structure:saef_select}

Used inside a SAEF form to select the parent and template assign to a page. Related SAEF documentation

Type

type=”template|parent”, defaults to none

Outputs form fields to select the template or parent

Siblings

{exp:structure:siblings}

This tag will traverse back and forth between siblings pages in your main navigation tree and auto-detect where you are in the hierarchy. Examples of its usage can be found in our sibling tag documentation examples.

Entry ID

entry_id="XX", defaults to Current page's ID

Allows you to force a different starting page.

Next (tag pair)

n/a - only variables

Available variables: title, url, entry_id, parent_id, channel_id, status

Previous (tag pair)

n/a - only variables

Available variables: title, url, entry_id, parent_id, channel_id, status

Title Trail

{exp:structure:titletrail}

The titletrail tag displays in a standardized format and has a few parameters to control its output. Format = Page You're On » Parent Page » Top Level Nav » Site Name

Custom Title Field

channel:title="channel:custom_field|channel_2:custom_field_2", defaults to entry title (when unset)

Uses a specific custom field per channel instead of the default title variable.

Entry ID

entry_id="XX", defaults to current page's ID

Specify a trail to show

Reverse

reverse="yes"

Output = "Site Name » Parent Page » Page You're On"

Separator

separator=":"

Spaces are automatically added around the element for you.

Site Name

site_name="yes", defaults to no

Adds your site name to the beginning of the trail.