Address Loop

Address loop lists address addresses.

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

Either a customer id or the keyword `current` which search for current customer addresses.

default : current

example : customer="current", customer="11"


A boolean value to return either customer default address either all the others.

example : default="true"


A single or a list of address ids to exclude.

example : exclude="456,123"


A single or a list of address ids.

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

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

Loop outputs

Variable Description
$ADDRESS1 the first address line
$ADDRESS2 the second address line
$ADDRESS3 the third address line
$CELLPHONE the address cellphone
$CITY the address city
$COMPANY the address company
$COUNTRY the address country which might be use in country loop
$CUSTOMER the customer the address is link to which might be use in customer loop
$DEFAULT return if address title is by default address
$FIRSTNAME the address firstname
$ID the address id
$LABEL the address label
$LASTNAME the address lastname
$PHONE the address phone
$TITLE the address title which might be use in title loop
$ZIPCODE the address zipcode