Grid Field¶

backspace=¶

backspace="7"

Just like the backspace parameter on the Channel Entries module, backspacing removes characters (including spaces and line breaks) from the last iteration of the loop.

dynamic_parameters=¶

dynamic_parameters="orderby|limit|sort"

The Dynamic Parameters feature permits a Grid field tag’s parameters to be set “on the fly” using POST data data submitted via a form. A practical use for this is to create some display options in a form on your page that your visitors can use to select their preferred page view.

Every parameter available to the Grid field tag can be set dynamically.

fixed_order=¶

fixed_order="10|21|15"

Allows the output of the tag pair to order rows in a fixed order of row IDs.

limit=¶

limit="5"

Limits the number of rows output by the tag pair to the number specified here.

offset=¶

offset="1"

Offsets the number of rows output by the tag pair to the number specified here.

orderby=¶

orderby="column_name"

Allows the output of the tag pair to be ordered by a specific column, defaults to row order as set on the channel entry publish form. Entering random will return the rows in a random order.

row_id=¶

row_id="5"

Tells the tag pair to only output rows for the rows specified. Multiple rows may be specified by separating them with a pipe character:

row_id="11|5|55"

Or use “not” to exclude rows:

row_id="not 8|15|87"

search:column_name=¶

search:height="<=20"

Tells the tag pair to return rows only matching a certain search criteria. The behavior and syntax is identical to the search parameter of the Channel Entries module.

sort=¶

sort="desc"

Specifies the direction of the sorting of the tag output. Defaults to ascending.

count¶

{gallery:count}

The “count” out of the current rows being displayed. If five rows are being displayed, then for the fourth entry the count variable would have a value of “4”.

field_row_count¶

{gallery:field_row_count}

The count of the row inside the field regardless of tag output.

field_row_index¶

{gallery:field_row_index}

The index of the row inside the field regardless of tag output.

field_total_rows¶

{gallery:field_total_rows}

The total number of rows in the field regardless of tag output criteria.

index¶

{gallery:index}

The count of the rows but starting at zero.

prev_row¶

{gallery:prev_row}
    <a href="/gallery/lumenhaus/{gallery:row_id}">Previous photo</a>
{/gallery:prev_row}

Used as a tag pair within the parent Grid field tag pair, provides access to data in the previous row in the dataset.

next_row¶

{gallery:next_row}
    <a href="/gallery/lumenhaus/{gallery:row_id}">Next photo</a>
{/gallery:next_row}

Used as a tag pair within the parent Grid field tag pair, provides access to data in the next row in the dataset.

row_id¶

{gallery:row_id}

The database ID of the current row.

switch=¶

{gallery:switch="odd|even"}

Identical to the switch variable available in the Channel Entries tag pair, but prefixed for your Grid field.

total_rows¶

{gallery:total_rows}

The total number of rows being returned by the current display criteria.

:average¶

{grid_field:average column="height" search:height=">55"}

Given a column name containing numeric data, returns the average of the column values in that field, or in the dataset paired down by additional criteria such as search.

:highest¶

{grid_field:highest column="height"}

Given a column name containing numeric data, returns the hightest of the column values in that field, or in the dataset paired down by additional criteria such as search.

:lowest¶

{grid_field:lowest column="height"}

Given a column name containing numeric data, returns the lowest of the column values in that field, or in the dataset paired down by additional criteria such as search.

:sum¶

{grid_field:sum column="height"}

Given a column name containing numeric data, returns the sum of the column values in that field, or in the dataset paired down by additional criteria such as search.

:table¶

{grid_field:table cellspacing="0" cellpadding="0"}

Outputs the data in the Grid field as a table. All parameters available to the primary tag are available in addition to these:

• border= Sets border attribute on the table’s HTML element
• cellspacing= Sets cellspacing attribute on the table’s HTML element
• cellpadding= Sets cellpadding attribute on the table’s HTML element
• class= Sets class attribute on the table’s HTML element
• id= Sets ID attribute on the table’s HTML element
• set_classes= If set to ‘y’, adds column name to the class attribute of each cell.
• set_widths= If set to ‘y’, sets the same column widths configured for each column in the Grid field’s settings.
• width= Sets width attribute on the table’s HTML element

:total_rows¶

{grid_field:total_rows search:height=">55"}

When outside of a Grid field tag pair, this modifier can be used to get the total number of rows in a field given a specific criteria.

:next_row¶

{grid_field:next_row row_id="{segment_3}"}
    Next up: <a href="/gallery/photo/{grid_field:row_id}">{grid_field:title}</a>
{/grid_field:next_row}

Given a row ID, this tag pair will provide access to the next row in the field criteria. The row_id may be populated via a segment variable.

:prev_row¶

{grid_field:prev_row row_id="5"}
    Previous: <a href="/gallery/photo/{grid_field:row_id}">{grid_field:title}</a>
{/grid_field:prev_row}

Given a row ID, this tag pair will provide access to the previous row in the field criteria. The row_id may be populated via a segment variable.