Tags
These terms are used throughout the documentation:
required: This parameter/field is required for this tag to function.
form only: This can only be set as a field in the form and not as a parameter in the tag.
param only: This parameter can only be set in the tag and not as a field in the form.
fixed value: This field cannot be edited and is set with a fixed value.
recurring only: This parameter/field only applies to recurring charges.
one-time only: This parameter/field only applies to one-time charges.
added in X.X.X: This parameter/field is only available from this version forward.
logged in: This tag is only available if the user is logged in.
required: This parameter/field is required for this tag to function.
form only: This can only be set as a field in the form and not as a parameter in the tag.
param only: This parameter can only be set in the tag and not as a field in the form.
fixed value: This field cannot be edited and is set with a fixed value.
recurring only: This parameter/field only applies to recurring charges.
one-time only: This parameter/field only applies to one-time charges.
added in X.X.X: This parameter/field is only available from this version forward.
logged in: This tag is only available if the user is logged in.
Low Reorder has the following front-end tags:
{exp:low_reorder:entries}
- The Entries tag supports all channel:entries parameters and variables. Any filters will be overridden by the given parameters, unless you set force_set_params to yes. The dynamic parameter is automatically set to no, if not explicitly set to yes.
{exp:low_reorder:prev_entry}
- Displays the previous entry in the set based on given entry_id or url_title. Works like its Channel module relative. See Next entry tag for available parameters and variables.
{exp:low_reorder:entry_ids}
- The Entry IDs tag will return a pipe-separated list of ordered entry IDs in the given set. You can use both the single tag syntax as the tag pair syntax. If you’re using it as a tag pair, use the variable {low_reorder:entry_ids} to output the entry IDs.
{exp:low_reorder:total_entries}
- Use this tag to get the total amount of entries in a Set.
{exp:low_reorder:pad}
- Use this tag to add padding to the value in the input value, like the str_pad() function in PHP.
{exp:low_reorder:entries}
The Entries tag supports all channel:entries parameters and variables. Any filters will be overridden by the given parameters, unless you set force_set_params to yes. The dynamic parameter is automatically set to no, if not explicitly set to yes.
Tag Parameters
- setrequired
- The ID or name of the Low Reorder Set. This is a required field.
{exp:low_reorder:entries set="my_set" disable="member_data|category_fields"}
{if count == 1}<ol>{/if}
<li>{title}</li>
{if count == total_results}</ol>{/if}
{/exp:low_reorder:entries}
- fallbacktrue/false
- Set to yes if you want to fall back to the regular channel:entries tag when no valid Low Reorder Set is found, instead of triggering no_results data.
{exp:low_reorder:entries fallback="true"}
- force_set_params
- Set to yes if you want to override tag parameters with the Set’s filter settings.
- reverse_count
- Set to customize the name of the reverse_count variable.
- prefix
- If set, the tag will parse variables that have the given prefix, eg. {prefix_title}. Use to avoid variable name conflicts when nesting this tag in other tags.
Variables
- low_reorder_category_id
- The category ID of given Low Reorder Set.
{low_reorder_category_id}
- low_reorder_set_id
- The Set ID of given Low Reorder Set.
{low_reorder_set_id}
- reverse_count
- Like {count}, but reversed: from {total_results} to 1.
{reverse_count}
Tag Parameters
- setrequired
- The ID or name of the Low Reorder Set. This is a required field.
{exp:low_reorder:next_entry set="my_set" url_title="{segment_2}"}
Next: <a href="{path="services/{url_title}"}">{title}</a>
{if no_results}This is the last page{/if}
{/exp:low_reorder:next_entry}
- entry_id
- Entry id of the current entry. If not defined, you must define the url_title.
{exp:low_reorder:next_entry entry_id="6" set="my_set"}
- url_title
- Url title of the current entry. If not defined, you must define the entry_id.
{exp:low_reorder:next_entry url_title="{segment_2}" set="my_set"}
- category
- Category id of the current entry. Use in combination with ordered entries that are put in a single category.
{exp:low_reorder:next_entry category="5" url_title="{segment_2}" set="my_set"}
- loopyes/no
- If set to yes, the entry lookup will work in a loop, returning the first one when viewing the last and vice versa.
{exp:low_reorder:next_entry loop="yes" category="5" url_title="{segment_2}" set="my_set"}
- prefix
- If set, the tag will parse variables that have the given prefix, eg. {prefix_title}. Use to avoid variable name conflicts when nesting this tag in other tags.
{exp:low_reorder:next_entry prefix="unique_identifier_for_variables" url_title="{segment_2}" set="my_set"}
- no_results
- If defined, the tag will return its value when there’s no previous or next entry. This value will override the {if no_results} conditional.
{exp:low_reorder:next_entry no_results="Sorry, nothing found" category="5" url_title="{segment_2}" set="my_set"}
Variables
- entry_id
- Entry id of the next/previous entry.
{entry_id}
- url_title
- Url title of the next/previous entry.
{url_title}
- title
- Title of the next/previous entry.
{title}
- page_uri
- The Pages URI next/previous entry.
{page_uri}
- page_url
- The Pages URL next/previous entry.
{page_url}
{exp:low_reorder:prev_entry}
Displays the previous entry in the set based on given entry_id or url_title. Works like its Channel module relative. See Next entry tag for available parameters and variables.
Tag Parameters
- Example
{exp:low_reorder:prev_entry set="1" url_title="{segment_2}"}
Previous: <a href="{path="services/{url_title}"}">{title}</a>
{if no_results}This is the first page{/if}
{/exp:low_reorder:prev_entry}
{exp:low_reorder:entry_ids}
The Entry IDs tag will return a pipe-separated list of ordered entry IDs in the given set. You can use both the single tag syntax as the tag pair syntax. If you’re using it as a tag pair, use the variable {low_reorder:entry_ids} to output the entry IDs.
Tag Parameters
- setrequired
- The ID or name of the Low Reorder Set. This is a required field.
{exp:low_reorder:entry_ids set="1"}
{low_reorder:entry_ids}
{/exp:low_reorder:entry_ids}
- category
- Category id of the Low Reorder Set. Use in combination with ordered entries that are put in a single category.
{exp:low_reorder:entry_ids category="1"}
- separator
- The character used to separate the entry IDs. Defaults to |Default: |
{exp:low_reorder:entry_ids seperator=","}
- no_results
- If defined, the tag will return its value when there are no matching entry IDs. This value will override the {if no_results} conditional.
{exp:low_reorder:entry_ids no_results="Sorry, nothing found"}
Tag Parameters
- setrequired
- The ID or name of the Low Reorder Set. This is a required field.
{exp:low_reorder:entry_index set="1" entry_id="5"}
- category
- Category id of the Low Reorder Set. Use in combination with ordered entries that are put in a single category
{exp:low_reorder:entry_index entry_id="5" set="1" category='1'}
- entry_idrequired
- Entry ID of the targeted entry in the Set. This is a required field.
{exp:low_reorder:entry_index entry_id="5" set="1"}
{exp:low_reorder:total_entries}
Use this tag to get the total amount of entries in a Set.
Tag Parameters
- setrequired
- The ID or name of the Low Reorder Set. This is a required field.
{exp:low_reorder:total_entries set="2" category="8"}
- category
- Category ID of the Low Reorder Set. Use in combination with ordered entries that are put in a single category.
{exp:low_reorder:total_entries category="8" set="2"}
{exp:low_reorder:pad}
Use this tag to add padding to the value in the input value, like the str_pad() function in PHP.
Tag Parameters
- input
- The input string to apply the padding to.
{exp:low_reorder:pad input="{count}" length="3"}
- lengthrequired
- Total length of the padded input. This is a required parameter.
{exp:low_reorder:pad length="3" input="{count}"}
- string
- Characters to use for the padding. Defaults to 0.Default: 0
{exp:low_reorder:pad string="add" length="3" input="{count}"}
- type
- Either left or right. Defaults to left.Default: left
{exp:low_reorder:pad type="right" string="add" length="3" input="{count}"}