Module Loop

The module loop retrieve module informations

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

A boolean value.

example : active="no"

area

A single or a list of area ids. Only modules assigned to this area will be returned.

example : area="5", profile="3,2,17"

code

Module code

example : code="Foo"

exclude

A single or a list of module ids to exclude.

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

id

A single or a list of module ids.

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

module_type

Module type (classic, payment or delivery)

Expected values :
  • 1 : classic module
  • 2 : delivery module
  • 3 : payment module

example : module_type="1"

order

A list of values

Expected values :
  • code : alphabetical order on module code
  • code_reverse : reverse alphabetical order on module code
  • enabled : ascending order on module enabled status
  • enabled_reverse : descending order on module enabled status
  • id : ascending order on module id
  • id_reverse : descending order on module id
  • manual : ascending order on module position (the default)
  • manual_reverse : descending order on module position
  • title : alphabetical order on title
  • title_reverse : reverse alphabetical order on title
  • type : ascending order on module type
  • type_reverse : descending order on module type

default : manual

example : order="alpha_reverse"

profile

A single or a list of profile ids.

example : profile="2", profile="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 Module
$UPDATE_DATE The last modification date of this Module

Loop outputs

Variable Description
$ACTIVE check if the module is activated or not
$CHAPO the module chapo
$CLASS The full namespace for the module class
$CODE The module code
$DESCRIPTION the module description
$ID the module ID
$IS_TRANSLATED return true if the module is translated
$LOCALE The locale used for this research
$POSITION the position of this module
$POSTSCRIPTUM the module postscriptum
$TITLE the module title
$TYPE The module type