Order status Loop
Order status loop displays order status information.
{loop type="order_status" 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 |
|---|---|
| id |
A single or a list of order status ids. example : id="2", id="1,4,7" |
| order |
A list of values
Expected values :
default : manual example : order="random" |
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 Order_status |
| $UPDATE_DATE | The last modification date of this Order_status |
Loop outputs
| Variable | Description |
|---|---|
| $CHAPO | the order status short description |
| $CODE | the order status code |
| $COLOR | the order status hexadecimal color code |
| $DESCRIPTION | the order status description |
| $ID | the order status id |
| $IS_TRANSLATED | whatever the order status is translated or not |
| $LOCALE | the order status locale |
| $POSITION | the order status position |
| $POSTSCRIPTUM | the order status postscriptum |
| $PROTECTED_STATUS | 1 if the order status is protected |
| $TITLE | the order status title |