Skip to documentation content

Field Values

On this page

    {{ data }} plus the stored field value types (text, date, toggle, dictionary, fieldset, and more). A custom field may also hold a Content object.

    {{ data }} holds the custom field values on an owner such as an entity. Those fields are also properties of the owner, so {{ article.hero }} and {{ article.data.hero }} are the same value. Use .data when you need the bag itself.

    A custom field value is polymorphic. Use object_type to tell which implementing type you have. This page catalogs {{ data }} and the dedicated stored-value types. A field can also hold a Content object (for example {{ entity }}, {{ article }}, or {{ image }}); those stay documented under Content.

    These stored-value types are distinct from Simple Object Types (string, number, boolean) and from Form Fields used to render HTML controls.

    Fieldsets group related child values on one owning entity, either as a single composite or as a repeating list of child objects. Access known field_ids, guard optional content with is_valid, and iterate repeating entries; do not output the whole fieldset as page content.

    Which of those two shapes you have is set by the field definition and reported by allow_multiple. When allow_multiple is false the fieldset holds one child object: read its known field_ids directly, or walk fields. When allow_multiple is true it holds an ordered list: iterate the fieldset itself or objects, and treat each entry as one child object carrying the configured child fields, not as another fieldset. Editors can reorder the entries of a repeating fieldset, so render them in the order they arrive rather than assuming a fixed position for any one entry. The kinds of link a Type `url` field can hold, and how an entity link keeps the URL it was saved with, are covered on the url field type page — not restated here.

    Field values in conditions
    A custom field is an object, not a bare value, and that matters in {% if %}:
    • A checkbox field object is always truthy. Test entity.featured.checked, not entity.featured.
    • Compare a field's value, not the field: {% if entity.layout.value == "wide" %}. Comparing the object itself to a string never matches.
    • Two field objects are equal only when they are the same object, so comparing two different fields' objects is almost never what you meant; compare their .value instead. Comparing an entity to an entity ({% if item == entity %}) does compare identity and is valid.
    • Guard an optional field with its own is_valid: {% if article.summary_html.is_valid %}…{% endif %}.

    Picker list values
    A picker list field (datastoreitemlist, articlelist, entitylist, taglist, and the other *list types) holds the selected objects in editor order and can be used directly: test is_valid, read size, take | first, and loop over it with {% for %}. Each item is the selected object itself, so its title, full_url, and custom fields read the same as anywhere else. No .items or .objects step is needed.

    {{ data }}

    The bag of custom field values on an owner such as an entity. Custom fields are also exposed as properties of that owner, so article.hero and article.data.hero are the same value. Use .data when you need the bag itself (enumerate, copy, or inspect).

    Properties
    Name Type Description
    object_type string Will always be data
    is_valid boolean Will be true if data contains one or more custom properties
    * object A custom field value accessed by field_id, using data.field_id or data['field-id']. Each value is one of the stored-value types on this page, or a Content object such as an entity or image
    output string JSON representation of the current data object, identical to {{ data | inspect: 4, false }}

    Prefer the promoted properties on the owner for ordinary output. {% for value in data %} walks the custom field values, not the field_id names. Data objects are copyable using the {% copy_to_dictionary %} method; the keys are field_ids and the values are the corresponding field value objects. Some non-entity objects also expose a data bag of named custom values.

    Example article.hero and article.data.hero are the same valueCustom fields are exposed both as direct properties on their owner and as entries in the owner's data bag by field_id. Use the direct property for ordinary output; use .data when you need the bag itself, such as looking up a field_id that is only known at render time.
    Liquid
    {%- if article.hero == article.data.hero -%}
	<p>Same value, read two ways.</p>
{%- endif -%}
{%- if article.data.is_valid -%}
	{%- assign lookup_id = "hero" -%}
	{%- if article.data[lookup_id].is_valid -%}
		{{ article.data[lookup_id] }}
	{%- endif -%}
{%- endif -%}

    article.hero and article.data.hero (or article.data["hero"]) resolve to the same custom field value; prefer the direct property when the field_id is known ahead of time. article.data.is_valid is true once the owner has at least one custom property. Indexing data by a variable field_id, as with lookup_id here, is the pattern to use when the field_id is not known until render time, such as one produced by a loop.

    {{ text }}

    Properties
    Name Type Description
    object_type string Will always be text
    is_valid boolean True if the value is not empty
    value string The raw unencoded value of the field - outputting the raw value may have unexpected results if the value contains HTML characters (ie: <, >, ' or ")
    default_value string The default value for this field if no value is specified
    field_id string The identifier for this field
    label string The label for this field
    output string The html encoded text of the field. May include additional markup in the editor preview to make it easier to edit content

    Field containing plain text input.

    Example Output a page text field valueOutput a page text field value.
    Liquid
    {%- if page.subtitle.is_valid -%}
	<h2 class="page_subtitle">{{ page.subtitle }}</h2>
{%- endif -%}

    {{ textarea }}

    Properties
    Name Type Description
    object_type string Will always be textarea
    is_valid boolean True if the value is not empty
    value string The raw unencoded value of the field - outputting the raw value may have unexpected results if the value contains any HTML characters (ie: <, >, ', or ")
    default_value string The default value for this field if no value is specified
    field_id string The identifier for this field
    label string The label for this field
    output string The html encoded text of the field. Line breaks in the textarea are converted to "<br />" tags. May include additional markup in the editor preview to make it easier to edit content

    Allows any input, but encodes it as text prior to displaying it.

    Example Output an entity textarea fieldOutput or validate an entity textarea field value; check is_valid when the field may be empty.
    Liquid
    {%- if entity.hero_description.is_valid -%}
	<div class="hero_cta_description">
		<p>{{ entity.hero_description }}</p>
	</div>
{%- endif -%}

    {{ textlist }}

    Field containing an ordered list of text values, usable directly as a list

    Properties
    Name Type Description
    object_type string Will always be textlist
    is_valid boolean True if the field contains at least one value
    value string The raw stored value of the field, which is a JSON array string such as ["first","second"]. For textlist fields you do not typically care about this - use values or iterate the field instead
    values list A list containing each text value in this field, in the order they were entered
    count integer The number of values in this field
    field_id string The identifier for this field
    label string The label for this field
    output string The values of this field joined together with a comma and a space. May include additional markup in the editor preview to make it easier to edit content

    Field containing multiple text values stored in one field, such as a list of email addresses. The field is itself a list of strings: iterate it with a {% for %} loop, index it directly with textlist[0], and use the list symbols first, last, and size on it. Iterating the field yields the same strings as values, so reach for values only when you want the list as its own object. Guard optional content with is_valid, or check count, before rendering. The field definition decides how many values an editor may enter and may drop duplicate entries, but at runtime the field simply exposes the values that were saved.

    {{ toggle }}

    Properties
    Name Type Description
    object_type string Will always be toggle
    is_valid boolean Always true
    value string on_value or off_value
    default_value string The default value for this field if no value is specified
    on boolean True if the toggle is "on". False if it is "off"
    on_label string The text to be displayed when the toggle is "on"
    on_value string The value represented by the "on" position
    on_color string The color of the toggle when it is "on" (could be any valid CSS color)
    off_label string The text to be displayed when the toggle is "off"
    off_value string The value represented by the "off" position
    off_color string The color of the toggle when it is "off" (could be any valid CSS color)
    field_id string The identifier for this field
    label string The label for this field
    output string on_label or off_label. May include additional markup in the editor preview to make it easier to edit content

    Represents an on/off toggle control

    Example Check if a toggle (boolean) field is onCheck whether a toggle (boolean) field is on before showing content or saving state.
    Liquid
    <p>Show subscriptions? <strong>{{ entity.show_subscription_form }}</strong></p>
{%- if entity.show_subscription_form.on -%}
	{%- include "Subscription Form" -%}
{%- endif -%}

    {{ select }}

    Properties
    Name Type Description
    object_type string Will always be select
    is_valid boolean True if one of the defined options is selected. To make a (none) option, define an option with an empty value
    value string Delimited string containing the values from all of the selected options. For select fields you do not typically care about this - use selected or values instead
    default_value string The default value for this field if no value is specified
    options object Contains all of the available options for this select list. Each option is a property on the object where they property key is the option value and the property value is the option text
    selected list A list containing the values from all of the selected options
    values list A list containing the text from all of the selected options
    count integer The number of selected options
    field_id string The identifier for this field
    label string The label for this field
    output string String containing the text from all of the selected options. May include additional markup in the editor preview to make it easier to edit content

    Represents the selection from a select list. The select list may or may not allow multiple selections (defaults to only allow a single selection).

    Example Read the selected options from select and checkboxlist fieldsselect and checkboxlist share the same options/selected/values/count shape. select holds a single-choice (or multi-choice) list; checkboxlist always holds multiple true/false checkboxes.

    Select field: read the selected option

    Liquid
    {%- if entity.status.is_valid -%}
	<p>Status: {{ entity.status.values | join: ", " }}</p>
{%- endif -%}

    entity.status.values is a list of the selected option text (entity.status.selected holds the underlying values instead). is_valid guards against no option being selected.

    Checkboxlist field: count and list the checked options

    Liquid
    {%- if entity.interests.count > 0 -%}
	<p>{{ entity.interests.count }} interest{% if entity.interests.count != 1 %}s{% endif %} selected:</p>
	<ul>
	{%- for interest in entity.interests.values -%}
		<li>{{ interest }}</li>
	{%- endfor -%}
	</ul>
{%- endif -%}

    {{ checkbox }}

    Represents a single true/false value.

    Properties
    Name Type Description
    object_type string Will always be checkbox
    is_valid boolean Will always be true
    value string The value saved in the field - typically either "true" or "false". For checkbox fields you do not typically care about this - use checked instead
    checked boolean True if the checkbox was checked
    field_id string The identifier for this field
    label string The label for this field
    output string "yes" or "no". . May include additional markup in the editor preview to make it easier to edit content
    Example Check if a toggle (boolean) field is onCheck whether a toggle (boolean) field is on before showing content or saving state.
    Liquid
    <p>Show subscriptions? <strong>{{ entity.show_subscription_form }}</strong></p>
{%- if entity.show_subscription_form.on -%}
	{%- include "Subscription Form" -%}
{%- endif -%}
    Example Checkbox Include Partial TemplateInclude a partial template conditionally when a checkbox (or other) field is checked.
    Liquid
    <p>Show Sidebar? <strong>{{ page.show_sidebar }}</strong></p>
{%- if page.show_sidebar.checked -%}
	{%- include "Sidebar" -%}
{%- endif -%}

    {{ checkboxlist }}

    Represents multiple true/false values

    Properties
    Name Type Description
    object_type string Will always be checkboxlist
    is_valid boolean Indicates whether or not this references a checkbox
    value string Delimited string containing the values from all of the checked checkboxes. For checkboxlist fields you do not typically care about this - use selected or values instead
    default_value string The default value for this field if no value is specified
    options object Contains all of the available options for this checkboxlist. Each option is a property on the object where they property key is the option value and the property value is the option text
    selected list A list containing the values from all of the checked checkboxes
    values list A list containing the text from all of the checked checkboxes
    count integer The number of checked checkboxes
    field_id string The identifier for this field
    label string The label for this field
    output string String containing the text from all of the checked checkboxes. May include additional markup in the editor preview to make it easier to edit content
    Example Read the selected options from select and checkboxlist fieldsselect and checkboxlist share the same options/selected/values/count shape. select holds a single-choice (or multi-choice) list; checkboxlist always holds multiple true/false checkboxes.

    Select field: read the selected option

    Liquid
    {%- if entity.status.is_valid -%}
	<p>Status: {{ entity.status.values | join: ", " }}</p>
{%- endif -%}

    entity.status.values is a list of the selected option text (entity.status.selected holds the underlying values instead). is_valid guards against no option being selected.

    Checkboxlist field: count and list the checked options

    Liquid
    {%- if entity.interests.count > 0 -%}
	<p>{{ entity.interests.count }} interest{% if entity.interests.count != 1 %}s{% endif %} selected:</p>
	<ul>
	{%- for interest in entity.interests.values -%}
		<li>{{ interest }}</li>
	{%- endfor -%}
	</ul>
{%- endif -%}

    {{ radio }}

    Properties
    Name Type Description
    object_type string Will always be radio
    is_valid boolean True if one of the defined options is selected
    value string The selected value
    selection string The text from the selected value
    default_value string The default value for this field if no value is specified
    field_id string The identifier for this field
    label string The label for this field
    output string The text from the selected value. May include additional markup in the editor preview to make it easier to edit content

    Stores the selected value from a list of radio inputs

    Example Read the selected value of a radio button fieldRead the selected value of a radio button field.
    Liquid
    {%- unless entity.prize_frequency.value == 0 -%}
	<p>Prizes are given away {{ entity.prize_frequency }}</p>
{%- endunless -%}

    {{ html }}

    Properties
    Name Type Description
    object_type string Will always be html
    is_valid boolean True if the value is not empty
    value string The HTML input. If there are any <liquid-markup> tags, they will be evaluated exactly once. Multiple references to value will yield the same result
    plain_value string The HTML input exactly as it was entered. Anytags will NOT be evaluated before returning the result
    interpreted_value string Identical to value, except that template code insidetags will be evaluated every time interpreted_value is referenced
    default_value string The default value (plain/uninterpreted) for this field if no value is specified
    field_id string The identifier for this field
    label string The label for this field
    output string Same as value - except that output is clickable in the preview site while value is not. May include additional markup in the editor preview to make it easier to edit content

    Allows any valid HTML input. May also include <liquid-markup> tags.

    Example Branch on object_type to handle code and html fields differentlycode and html are both raw, unvalidated text, but their extra properties differ: code exposes code_type (js, css, less, scss, or liquid); html exposes plain_value (never evaluated) and interpreted_value (liquid-markup tags evaluated on every reference). Use object_type to tell which one a field holds.
    Liquid
    {%- assign block = entity.content_block -%}
{%- if block.object_type == "code" and block.is_valid -%}
	{%- if block.code_type == "css" -%}
		<style>{{ block }}</style>
	{%- else -%}
		<script>{{ block }}</script>
	{%- endif -%}
{%- elsif block.object_type == "html" and block.is_valid -%}
	{{ block.interpreted_value }}
{%- endif -%}

    content_block could be configured as either a code field or an html field, so check object_type before deciding how to render it. code is not evaluated or processed before being output, so use it with caution and prefer a code_type check before choosing how to wrap it. html evaluates any <liquid-markup> tags each time interpreted_value is referenced; use plain_value instead when the tags should not run (for example, to display the field's raw source).

    {{ code }}

    Properties
    Name Type Description
    object_type string Will always be code
    is_valid boolean True if the value is not empty
    value string User-defined. No validation. Could be anything
    code_type string The type of code the value is written as - will either be null, js, css, less, scss, or liquid
    default_value string The default value for this field if no value is specified
    field_id string The identifier for this field
    label string The label for this field
    output string The value as it was input by the user, which is the same as the value property. May include additional markup in the editor preview to make it easier to edit content

    Contains code - which may be any of CSS, Javascript, Liquid Markup, JSON objects, or any other type of code. This code is not evaluated or processed before being output. Use with extreme caution.

    Example Branch on object_type to handle code and html fields differentlycode and html are both raw, unvalidated text, but their extra properties differ: code exposes code_type (js, css, less, scss, or liquid); html exposes plain_value (never evaluated) and interpreted_value (liquid-markup tags evaluated on every reference). Use object_type to tell which one a field holds.
    Liquid
    {%- assign block = entity.content_block -%}
{%- if block.object_type == "code" and block.is_valid -%}
	{%- if block.code_type == "css" -%}
		<style>{{ block }}</style>
	{%- else -%}
		<script>{{ block }}</script>
	{%- endif -%}
{%- elsif block.object_type == "html" and block.is_valid -%}
	{{ block.interpreted_value }}
{%- endif -%}

    content_block could be configured as either a code field or an html field, so check object_type before deciding how to render it. code is not evaluated or processed before being output, so use it with caution and prefer a code_type check before choosing how to wrap it. html evaluates any <liquid-markup> tags each time interpreted_value is referenced; use plain_value instead when the tags should not run (for example, to display the field's raw source).

    {{ labels }}

    Field containing a list of key-value pairs where the keys are not necessarily unique

    Properties
    Name Type Description
    object_type string Will always be labels
    is_valid boolean True if there is at least one key-value pair
    value string A comma-delimited list of all of the key-value pairs in this field using the form "key1:value1,key2:value2,etc..." For labels fields you do not typically care about this - use values instead
    keys list A list containing all of the unique keys in this field
    values object An object containing all of the keys and values of this field. Each object has a Key property and a Value property
    count integer The number of key-value pairs in the dictionary
    field_id string The identifier for this field
    label string The label for this field
    output string Same as value. May include additional markup in the editor preview to make it easier to edit content

    Field containing a list of key-value pairs where the keys are not necessarily unique. You may also treat this object as a list containing all of the key-value pairs which may be iterated using a {% for %} loop. For more details, see the examples below:

    Example List all keys, values, and objects in fieldsIterate over dictionary fields (keys/values), labels fields (Key/Value pairs), and fieldset fields (objects or individual values). See also list-all-cookies and list-all-custom-properties for related patterns.

    Dictionary field: keys and values

    Liquid
    <ul>
{%- for key in entity.dictionary_field %} --equivalent to {% for key in entity.dictionary_field.keys -%}
	<li><strong>{{key}}</strong> = {{entity.dictionary_field.values[key]}}</li>
{%- endfor -%}
</ul>

    Labels field: keys and values

    Liquid
    <ul>
{%- for kvp in entity.labels -%}
	<li><strong>{{kvp.Key}}</strong> = {{kvp.Value}}</li>
{%- endfor -%}
</ul>

    Fieldset field: all objects

    Liquid
    {%- if entity.fieldset.is_valid and entity.fieldset.allow_multiple -%}
	<ul>
		{%- for object in entity.fieldset %} --equivalent to {% for object in entity.fieldset.objects -%}
			<li><strong>{{ object.custom_title }}</strong>{% if object.custom_description.is_valid %}<br />
			   {{- object.custom_description }}{% endif %}</li>
		{%- endfor -%}
	</ul>
{%- endif -%}

    Fieldset field: all values

    Liquid
    {%- if entity.fieldset.is_valid -%}
	{%- unless entity.fieldset.allow_multiple -%}
		<ul>
			{%- for field in entity.fieldset %} --equivalent to {% for field in entity.fieldset.fields -%}
				<li><strong>{{field.field_id}}</strong> = {{field.output}}</li>
			{%- endfor -%}
		</ul>
	{%- endunless -%}
{%- endif -%}

    {{ fieldset }}

    A group of related child fields exposed as either one structured custom object or a repeating list of child custom objects.

    Properties
    Name Type Description
    object_type string Will always be fieldset
    is_valid boolean True when the fieldset contains content. Use this as the rendering guard before accessing or iterating its children.
    value string An inspection representation of the fieldset. Normal templates should access its child fields or child custom objects instead.
    allow_multiple boolean True when the fieldset is repeating. A repeating fieldset exposes child custom objects through objects and iteration; a non-repeating fieldset exposes one custom object through fields and direct child access.
    objects list The ordered list of child custom objects when allow_multiple is true. Each item contains the fieldset's configured child fields.
    fields list The child fields of the single custom object when allow_multiple is false. Known child FieldIDs can also be accessed directly from the fieldset.
    field_id string The identifier for this field
    label string The label for this field
    output string An inspection representation of the fieldset. Render the relevant child fields or child custom objects for production output.. May include additional markup in the editor preview to make it easier to edit content

    A fieldset keeps related values together inside one owning entity. When allow_multiple is false, access known child FieldIDs directly (object.keyName or object["keyName"]) or through fields (object.fields.keyName or object.fields["keyName"]); iterating the fieldset or fields yields the individual child field objects. When allow_multiple is true, iterate the fieldset or objects to receive one child custom object per entry, then access that object's named child fields. A repeated item is a child custom object, not another fieldset. Guard optional content with is_valid before rendering. Use inspect during development when the runtime shape is unfamiliar, but do not use the fieldset's raw inspection representation as the production UI.

    Example Access fields in a single-object fieldsetGuard a non-repeating fieldset, then access known child FieldIDs directly, through fields, or with bracket notation.

    Access a known child directly

    Liquid
    {%- if entity.fieldset.is_valid and entity.fieldset.field1.is_valid -%}
	<p>Field 1 Value: {{ entity.fieldset.field1 }}</p>
{%- endif -%}

    For a non-repeating fieldset, a known child FieldID can be accessed directly. The selected value remains its documented child field type.

    Access a child through fields

    Liquid
    {%- if entity.fieldset.is_valid and entity.fieldset.fields.field2.is_valid -%}
	<p>Field 2 Value: {{ entity.fieldset.fields.field2 }}</p>
{%- endif -%}

    The fields property makes the single-object shape explicit while returning the same documented child field type.

    Use bracket notation when needed

    Liquid
    {%- if entity.fieldset.is_valid and entity.fieldset['field-with-hyphens'].is_valid -%}
	<p>Field Value: {{ entity.fieldset['field-with-hyphens'] }}</p>
{%- endif -%}

    Use bracket notation when a FieldID is not suitable for dot notation. The selected value still keeps its documented child field type.

    Example Render repeating fieldset objectsGuard a repeating fieldset, iterate its child custom objects, and render named child fields from each entry.
    Liquid
    {%- if entity.whyus_reasons.is_valid -%}
	<ul>
		{%- for reason in entity.whyus_reasons -%}
			<li>
				<strong>{{ reason.title }}</strong>
				{%- if reason.description.is_valid -%}
					<div>{{ reason.description }}</div>
				{%- endif -%}
			</li>
		{%- endfor -%}
	</ul>
{%- endif -%}

    Because whyus_reasons is repeating, each loop value is one child custom object containing the configured title and description fields. It is not another fieldset object.

    Example Inspect a fieldset during developmentUse bounded inspection to understand or troubleshoot an unfamiliar fieldset before writing intentional child-field output.
    Liquid
    {%- if entity.whyus_reasons.is_valid -%}
	{{ entity.whyus_reasons | inspect: 3 }}
{%- endif -%}

    The inspect filter reveals the repeating fieldset, its child custom objects, and their fields up to the requested depth. Use this while developing or troubleshooting, then replace it with production rendering of the required child fields.

    Example List all keys, values, and objects in fieldsIterate over dictionary fields (keys/values), labels fields (Key/Value pairs), and fieldset fields (objects or individual values). See also list-all-cookies and list-all-custom-properties for related patterns.

    Dictionary field: keys and values

    Liquid
    <ul>
{%- for key in entity.dictionary_field %} --equivalent to {% for key in entity.dictionary_field.keys -%}
	<li><strong>{{key}}</strong> = {{entity.dictionary_field.values[key]}}</li>
{%- endfor -%}
</ul>

    Labels field: keys and values

    Liquid
    <ul>
{%- for kvp in entity.labels -%}
	<li><strong>{{kvp.Key}}</strong> = {{kvp.Value}}</li>
{%- endfor -%}
</ul>

    Fieldset field: all objects

    Liquid
    {%- if entity.fieldset.is_valid and entity.fieldset.allow_multiple -%}
	<ul>
		{%- for object in entity.fieldset %} --equivalent to {% for object in entity.fieldset.objects -%}
			<li><strong>{{ object.custom_title }}</strong>{% if object.custom_description.is_valid %}<br />
			   {{- object.custom_description }}{% endif %}</li>
		{%- endfor -%}
	</ul>
{%- endif -%}

    Fieldset field: all values

    Liquid
    {%- if entity.fieldset.is_valid -%}
	{%- unless entity.fieldset.allow_multiple -%}
		<ul>
			{%- for field in entity.fieldset %} --equivalent to {% for field in entity.fieldset.fields -%}
				<li><strong>{{field.field_id}}</strong> = {{field.output}}</li>
			{%- endfor -%}
		</ul>
	{%- endunless -%}
{%- endif -%}

    {{ dictionary }}

    Object containing a list of key-value pairs where the keys are unique.

    Properties
    Name Type Description
    object_type string Will always be dictionary
    is_valid boolean True if there is at least one key-value pair
    value string The json representation of the values. For dictionary fields you do not typically care about this - use values instead
    editable boolean True if properties can be added or removed from this dictionary. This will only be true if the dictionary was created using the {% create_dictionary %} method
    keys list A list of strings containing all of the keys in the dictionary
    values object An object containing all of the keys and values of the dictionary
    count integer The number of key-value pairs in the dictionary
    field_id string The identifier for this field
    label string The label for this field
    output string The JSON representation of the values. May include additional markup in the editor preview to make it easier to edit content

    Individual dictionary values may be accessed using the {{ dictionary.keyName }}, {{ dictionary["keyName"] }}, {{ dictionary.values.keyName }}, or dictionary.values["keyName"] syntax. You may also treat this object as a list containing all of the keys which may be iterated using a {% for %} loop.

    Example List all keys, values, and objects in fieldsIterate over dictionary fields (keys/values), labels fields (Key/Value pairs), and fieldset fields (objects or individual values). See also list-all-cookies and list-all-custom-properties for related patterns.

    Dictionary field: keys and values

    Liquid
    <ul>
{%- for key in entity.dictionary_field %} --equivalent to {% for key in entity.dictionary_field.keys -%}
	<li><strong>{{key}}</strong> = {{entity.dictionary_field.values[key]}}</li>
{%- endfor -%}
</ul>

    Labels field: keys and values

    Liquid
    <ul>
{%- for kvp in entity.labels -%}
	<li><strong>{{kvp.Key}}</strong> = {{kvp.Value}}</li>
{%- endfor -%}
</ul>

    Fieldset field: all objects

    Liquid
    {%- if entity.fieldset.is_valid and entity.fieldset.allow_multiple -%}
	<ul>
		{%- for object in entity.fieldset %} --equivalent to {% for object in entity.fieldset.objects -%}
			<li><strong>{{ object.custom_title }}</strong>{% if object.custom_description.is_valid %}<br />
			   {{- object.custom_description }}{% endif %}</li>
		{%- endfor -%}
	</ul>
{%- endif -%}

    Fieldset field: all values

    Liquid
    {%- if entity.fieldset.is_valid -%}
	{%- unless entity.fieldset.allow_multiple -%}
		<ul>
			{%- for field in entity.fieldset %} --equivalent to {% for field in entity.fieldset.fields -%}
				<li><strong>{{field.field_id}}</strong> = {{field.output}}</li>
			{%- endfor -%}
		</ul>
	{%- endunless -%}
{%- endif -%}
    Example Create a settings dictionary (key-value map)Build a settings dictionary (key-value map) and use it for configuration or display.
    Liquid
    {%- capture settings -%}
  inputs: posts
  number: 5
  style: 'two-tone'
  sortable: false
  original_entity: entity
{%- endcapture -%}
{%- create_dictionary settings = *settings -%}
{{- settings | inspect }}
    Example Reference dictionary field properties in multiple waysReference dictionary field properties with dot notation, bracket notation, or keys/values iteration.

    Reference a single field as a property

    Liquid
    {%- if entity.dictionary_field.custom_key_1 is_valid -%}
	<p>Custom Key 1: {{entity.dictionary_field.custom_key_1}}</p>
{%- endif -%}

    Reference a single field as a dictionary key

    Liquid
    {%- if entity.dictionary_field['custom_key_2'] is_valid -%}
	<p>Custom Key 2: {{entity.dictionary_field['custom_key_2']}}</p>
{%- endif -%}

    Reference a single field as a property of the values object

    Liquid
    {%- if entity.dictionary_field.values.custom_key_3 is_valid -%}
	<p>Custom Key 3: {{entity.dictionary_field.values.custom_key_3}}</p>
{%- endif -%}

    Reference a single field as a dictionary key of the values object

    Liquid
    {%- if entity.dictionary_field.values['custom_key_4'] is_valid -%}
	<p>Custom Key 4: {{entity.dictionary_field.values['custom_key_4']}}</p>
{%- endif -%}

    List all dictionary fields from keys

    Liquid
    <ul>
	{%- for field in entity.dictionary_field.keys -%}
		<li><strong>{{ field }}</strong> = {{ entity.dictionary_field.values[field] }}</li>
	{%- endfor -%}
</ul>

    Output an unordered list containing all of the dictionary field properties and their values by enumerating the keys property.

    List all dictionary fields from the dictionary object

    Liquid
    <ul>
	{%- for field in entity.dictionary_field -%}
		<li><strong>{{ field }}</strong> = {{ entity.dictionary_field[field] }}</li>
	{%- endfor -%}
</ul>

    Directly enumerating the dictionary object is the same as enumerating the keys property, so this example is functionally identical to the previous example.

    {{ url }}

    Field containing a URL.

    Properties
    Name Type Description
    object_type string Will always be url
    value string The URL as input into the field
    url_type string The type of object selected as a URL. Options are 'None', 'Custom', 'Entity', 'Image', 'Document', 'Email', 'Tel', and 'Javascript'
    reference_guid string The unique identifier for the selected object when url_type is either 'Entity', 'Image', or 'Document'
    entity {{ entity }} The entity object that this URL links to
    image {{ image }} The image object that this url links to
    document {{ document }} The document object that this url links to
    field_id string The identifier for this field
    label string The label for this field
    output string The URL as input into the field. May include additional markup in the editor preview to make it easier to edit content
    Example Create a link using a URL from a fieldCreate a link (anchor tag) using a URL from an entity or page field.
    Liquid
    {%- if entity.inspiration_url.is_valid -%}
	<p>
		<a href="{{ entity.inspiration_url.value }}">
			<img src="https://domain.com/path/to/image">
		</a><br />
		Inspired By {{ entity.inspiration_url -}}
	</p>
{%- endif -%}

    {{ date }}

    A field containing a user-selected date

    Properties
    Name Type Description
    object_type string Will always be date
    is_valid boolean True if the value is not empty
    value string Unformatted date string (in UTC)
    date {{ time }} An object containing more detailed information about the selected date
    default_value string The default value for this field if no value is specified
    field_id string The identifier for this field
    label string The label for this field
    output string The value formatted using the "Short date pattern" (MM/dd/yyyy). May include additional markup in the editor preview to make it easier to edit content

    Field used to store a date. All dates are stored in UTC time.

    Example Format an entity date field with the date filterFormat an entity date field (e.g. date_opened) for display using the date filter.
    Liquid
    {%- if entity.date_opened.is_valid -%}
	<p><strong>Date Opened</strong>: {{ entity.date_opened | date: "MMMM dd, yyyy" }}</p>
{%- endif -%}

    {{ datetime }}

    A field containing a user-selected date

    Properties
    Name Type Description
    object_type string Will always be datetime
    is_valid boolean True if the value is not empty
    value string Unformatted date string (in UTC)
    date {{ time }} An object containing more detailed information about the selected date and time
    default_value string The default value for this field if no value is specified
    field_id string The identifier for this field
    label string The label for this field
    output string The value formatted using the "Short date pattern" (MM/dd/yyyy). May include additional markup in the editor preview to make it easier to edit content

    Field used to store a date. All dates are stored in UTC time.

    Example Use a post_date or date-time field with the date filterUse a post_date or other date-time field and format or compare it with the date filter and date properties.
    Liquid
    {%- if entity.rehearsal_start.is_valid -%}
	<p>Rehearsal will begin on {{ entity.rehearsal_start | date: "MMMM dd, yyyy 'at' h:m t" }} UTC</p>
{%- endif -%}

    {{ timezone }}

    Properties
    Name Type Description
    object_type string Will always be timezone
    is_valid boolean True if the value is a valid timezone string
    value string timezone string
    default_value string The default value for this field if no value is specified
    field_id string The identifier for this field
    label string The label for this field
    output string timezone string. May include additional markup in the editor preview to make it easier to edit content

    Stores the timezone that should be used when displaying a date and/or time.

    {{ objecttype }}

    Properties
    Name Type Description
    object_type string Will always be objecttype
    is_valid boolean True if at least one object type is selected (exactly one if multiple selections are not allowed)
    value string Delimited string containing the values from all of the selected options. For objecttype fields you do not typically care about this - use values instead
    options list A list containing all of the available object type options
    values list A list containing all of the selected object types
    count integer The number of selected object types
    field_id string The identifier for this field
    label string The label for this field
    output string String containing the text from all of the selected options. May include additional markup in the editor preview to make it easier to edit content

    Represents the selection of one or more object types from a list. The list may or may not allow multiple selections.

    Example Read the object types selected by an objecttype fieldobjecttype represents the selection of one or more object types from a list, using the same values/count shape as select and checkboxlist. options lists every available object type; values lists the ones actually selected.
    Liquid
    {%- if entity.related_kinds.is_valid -%}
	<p>Applies to {{ entity.related_kinds.count }} object type{% if entity.related_kinds.count != 1 %}s{% endif %}: {{ entity.related_kinds.values | join: ", " }}</p>
{%- endif -%}

    is_valid is true once at least one object type is selected (exactly one if the field does not allow multiple selections). values holds the selected object type names; options would list every object type the field could select from, regardless of selection.

    {{ entitytypes }}

    Field containing a list of object types.

    Properties
    Name Type Description
    object_type string Will always be entitytypes
    is_valid boolean True if the value is not empty
    value string The value saved in the field. For entitytypes fields you do not typically care about this - use values instead
    default_value string The default value for this field if no value is specified
    field_id string The identifier for this field
    label string The label for this field
    output string A comma-delimited list of object types. May include additional markup in the editor preview to make it easier to edit content

    Field containing a list of object types.

    Related

    article

    Entity

    What an entity is, shared properties on every entity, and the entities query API.

    article

    Field Types

    Every custom field Type, what it stores, and where it is valid.