Folder path Loop
Folder path loop provides the path through the catalog to a given folder. For example if we have an "alpha" folder standing in an "alpha_father" folder which itseflf belong to "root" folder. Folder path loop for folder "alpha" will return "root" then "alpha_father" then "alpha".
{loop type="folder-path" 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 |
|---|---|
| depth |
The max depth example : depth="5" |
| folder * |
A single folder id. example : folder="2" |
| visible |
Whatever we consider hidden folder or not. default : true example : visible="false" |
Global outputs
| Variable | Description |
|---|---|
| $LOOP_COUNT | the current results index, starting from 1 |
| $LOOP_TOTAL | the total number of results returned by the loop |
Loop outputs
| Variable | Description |
|---|---|
| $ID | the folder id |
| $LOCALE | the locale |
| $TITLE | the folder title |
| $URL | the folder URL |