Area Loop
Area loop returns shipping zones information.
{loop type="area" name="the-loop-name" [argument="value"], [...]}Important informations :
* : argument is required
** : at least one of ** marked argument is required
Global arguments
| Argument | Description |
|---|---|
| backend_context |
Determine if loop is use in backend context. default : false example : backend_context="on" |
| force_return |
force return result for i18n tables even if there is no record default : false example : force_return="on" |
| limit |
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) |
| offset |
The first product to display offset. Will not be used if `page` argument is set. default : 0 example : offset="1" |
| page |
The page to display. example : page="2" |
Loop arguments
| Argument | Description |
|---|---|
| country |
(2.2) A list of country IDs. Only zones including these countries will be returned |
| id |
A single or a list of shipping zones ids. example : id="2", id="1,4,7" |
| module_id |
A comma separated list of module IDs. If not empty, only zones for the specified modules are returned. |
| order |
A list of values
Expected values :
default : manual example : order="alpha" |
| unassigned |
If true, returns shipping zones not assigned to any delivery module. |
| with_zone |
A module ID. Returns shipping zones which are assigned to this module ID |
| without_zone |
A module ID. Returns shipping zones which are not assigned to this module ID |
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 Area |
| $UPDATE_DATE | The last modification date of this Area |
Loop outputs
| Variable | Description |
|---|---|
| $ID | the shipping zone id |
| $NAME | the shipping zone name |
| $POSTAGE | This parameter is always zero in 2.0.0 |