Common options
display
: specifies whether to display posts or terms from a taxonomy
- Default value:
posts
. - May only contain one value.
- Must be set to either
posts
orterms
. - Any value other than
posts
orterms
will default to displaying posts.
numbers
: appends or prepends numerals to the alphabet
- Default value:
unset
. - May only contain one value.
- Must be set to either
before
orafter
. - Any value other than
before
orafter
will default to appending numerals to the alphabet.
grouping
: tells the plugin if and how to group the alphabet
- Default value:
unset
. - May only contain one value.
- Must be set to any positive number greater than
1
or the valuenumbers
. - Any value other than a positive number or the value
numbers
will default to disabling all grouping functionality. - When set to a number higher than
1
the listing will group letters together into ranges. - For example, if you chose
3
then a Latin alphabet will group togetherA
,B
, andC
intoA-C
. Likewise forD-F
,G-I
and so-on. - When using this setting, if numbers are also shown via the
numbers="before"
ornumbers="after"
attribute then they will be shown as a single separate group0-9
. - When set to the value
numbers
it will group numerals into a single group0-9
. - This requires the numbers to be displayed via the
numbers="before"
ornumbers="after"
attributes.
group-numbers
: tells the plugin to group all items beginning with a numeral into a single collection
- Default value:
false
. - May only contain one value.
- Must be set to
true
,yes
,on
, or1
to group items beginning with a numeral in a single collection. All other values will keep the default behaviour.
alphabet
: allows you to override the alphabet that the plugin uses
- Default value:
unset
. - When this attribute is not defined, the plugin will either use the untranslated default, or if glotpress includes a translation for your site’s language as set in
Admin -> Settings -> Site Language
it will use that translation. - The current untranslated default is:
AÁÀÄÂaáàäâ,Bb,Cc,Dd,EÉÈËÊeéèëê,Ff,Gg,Hh,IÍÌÏÎiíìïî,Jj,Kk,Ll,Mm,Nn,OÓÒÖÔoóòöô,Pp,Qq,Rr,Ssß,Tt,UÚÙÜÛuúùüû,Vv,Ww,Xx,Yy,Zz
. - Accepts a single line of letters/symbols, which need to be separated via the comma character
,
. - Including more than one letter/symbol in each group will display posts starting with any of those under the same section.
- The first letter/symbol in each group is used as the group’s heading when displayed on your site.
Posts options
post-type
: sets the listing to show a specific post-type
- Default value:
page
. - Multiple post-types may be specified by separating with commas (
,
) e.g.post-type="page,post"
. - Must be the
slug
of the post-type(s).
parent-post
: sets the parent post that all displayed posts must be descended from
- Default value:
unset
. - May only contain one value.
- Must be the
ID
of the parent post. - Add
get-all-children="yes"
to also include all descendants of any depth below the parent post.
exclude-posts
: remove these posts from the list
- Default value:
unset
. - Multiple posts may be specified by separating by commas:
,
. - Must be the
ID
of the post(s).
taxonomy
: sets the taxonomy containing the terms specified in the terms=""
option
- Default value:
unset
. - May only contain one value.
- Must be the
slug
of the taxonomy.
terms
: sets the taxonomy terms for filtering posts
- Default value:
unset
. - The taxonomy must also be specified in
taxonomy
. - Multiple terms may be specified by separating with commas:
,
. - Must be the
slug
of the term(s).
Terms options
taxonomy
: sets the taxonomy to display terms from in the listing
- Default value:
unset
. - Multiple taxonomies may be specified by separating with commas:
,
. - Must be the
slug
of the taxonomy.
terms
: sets the taxonomy terms to include in the listing
- Default value:
unset
. - The taxonomy must also be specified in
taxonomy
. - Multiple terms may be specified by separating with commas:
,
. - Must be the
ID
of the term(s). - Cannot be used with
exclude-terms=""
.
exclude-terms
: sets the terms to exclude from display
- Default value:
unset
. - The taxonomy must also be specified in
taxonomy
. - Multiple terms may be specified by separating with commas:
,
. - Must be the
ID
of the term(s). - Cannot be used with
terms=""
.
parent-term
: set the parent that all displayed terms must be descended from
- Default value:
unset
. - May only contain one value.
- Must be the
slug
of the parent term. - Add
get-all-children="yes"
to also include all descendants of any depth below the parent term.
get-all-children
: when a parent term is chosen this option is used to show all children of any depth or only direct children
- Default value:
false
. - May only contain one value.
- Must be set to
true
,yes
,on
, or1
to include all children of any depth. Any value other will use the default behaviour of only showing direct children.
hide-empty-terms
: hide terms that have no posts associated
- Default value:
false
. - May only contain one value.
- Must be set to
true
,yes
,on
, or1
to hide the empty terms. Any other value will use the default behaviour of showing all terms.
Internal-use options for completeness
You should not need to touch these, as they are meant for internal use by the plugin only
target
: the default target for a listing that doesn’t show any items
- Default value:
unset
. - May only contain one value.
- Must be set to a URL which will be used as the target for the letters’ hyperlinks.
return
: what type of listing to show, either listing
or letters
- Default value:
listing
. - May only contain one value.
- Must be set to either
listing
to display the default view, orletters
to show only the letters without any items (posts or terms).