Delivery Loop

delivery loop displays delivery modules information.

{loop type="delivery" 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
address

An address id.

example : address=21

code

A module code.

example : code='Atos'

country

A country id.

example : country=2

exclude

A list of module IDs to exclude from the results

example : exclude="12, 21"

exclude_code
Thelia >= 2.4

A list of module codes to exclude from the results

example : exclude_code="Cheque,Atos"

id

A module id.

example : module=4

order

A single value in the list below

Expected values :
  • alpha : alphabetical order on title
  • alpha_reverse : reverse alphabetical order on title
  • id : sort by id
  • id_reverse : sort by id reverse
  • manual : same position as defined in back-office
  • manual_reverse : reverse position as defined in back-office

default : manual

example : order="id_reverse"

state
Thelia >= 2.3

A state id.

example : state=12

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 Delivery
$UPDATE_DATE The last modification date of this Delivery

Loop outputs

Variable Description
$CHAPO the delivery module short description
$CODE the module code
$DELIVERY_DATE the expected delivery date. This output could be empty.
$DESCRIPTION the delivery module description
$ID the delivery module id
$POSTAGE the delivery price with taxes, expressed in the current currency
$POSTAGE_TAX The delivery price tax amount, expressed in the current currency
$POSTAGE_TAX_RULE_TITLE The tax rule title used to get delivery price tax
$POSTAGE_UNTAXED the delivery price without taxes, expressed in the current currency
$POSTSCRIPTUM the delivery module postscriptum
$TITLE the delivery module title