State Loop

This functionality is only available since version 2.3

State loop lists states.

{loop type="state" name="the-loop-name" [argument="value"], [...]}

Important informations :

* : argument is required
** : at least one of ** marked argument is required

Global arguments

Argument Description

Determine if loop is use in backend context.

default : false

example : backend_context="on"


force return result for i18n tables even if there is no record

default : false

example : force_return="on"


The maximum number of results to display.

example : limit="10"

name *

The loop name. This name must be unique and is used to reference this loop further in the page (see ifloop, elseloop or pageloop)


The first product to display offset. Will not be used if `page` argument is set.

default : 0

example : offset="1"


The page to display.

example : page="2"

Loop arguments

Argument Description

A single or a list of country ids.

example : country="10,9", country: "500"


A single or a list of state ids to exclude from the results.

example : exclude="2", exclude="1,4,7"


A single or a list of state ids.

example : id="2", id="1,4,7"


A lang id

example : lang="1"


A list of values for sort order

Expected values :
  • alpha : alphabetical order on title
  • alpha-reverse : reverse alphabetical order on title
  • id : order by ascending id
  • id_reverse : order by descending id
  • random : return states in pseudo-random order
  • visible : order by ascending visibility
  • visible_reverse : order by descending visibility

default : id

example : order="alpha_reverse"


A boolean value to return visible or not visible states (possible values : yes, no or *).

default : yes

example : visible="no"

Global outputs

Variable Description
$LOOP_COUNT the current results index, starting from 1
$LOOP_TOTAL the total number of results returned by the loop
$CREATE_DATE The creation date of this State
$UPDATE_DATE The last modification date of this State

Loop outputs

Variable Description
$COUNTRY the country the state belongs
$ID the state id
$ISOCODE the state ISO code
$IS_TRANSLATED check if the state is translated
$LOCALE The locale used for this research
$TITLE the state title
$VISIBLE true if the state is visible. False otherwise