Plugin / A-Z Listing

Description

Show your posts, pages, and terms alphabetically in a Rolodex-, catalogue-, or directory-style list with the A-Z Listing plugin!

The plugin has a short-code for the list, and a widget so you can link to the list from anywhere on your site. If a letter doesn’t have any pages then the widget will display the letter unlinked. The list page will omit the display for that letter entirely.

Show posts from any or multiple post types including the in-built posts and pages. Also supported are post-types from plugins like WooCommerce products. Alternatively, show terms like categories or tags.

short-code

The plugin supplies a short-code for the full A-Z listing allowing use without modifying your theme’s templates.

Basic usage is as follows:

[a-z-listing]

To specify a post-type to display instead of page then use, e.g. post:

[a-z-listing display="posts" post-type="post"]

To filter the posts by a term from a taxonomy:

[a-z-listing display="posts" taxonomy="category" terms="my-term-slug"]

To display pages that are direct children of the page with ID 24:

[a-z-listing display="posts" post-type="page" parent-post="24"]

To display pages that are children of any depth below the page with ID 24:

[a-z-listing display="posts" post-type="page" parent-post="24" get-all-children="yes"]

To show terms from a taxonomy instead of posts and pages, e.g. Terms from the Categories taxonomy:

[a-z-listing display="terms" taxonomy="category"]

To show terms from the Categories taxonomy that are direct children of the term with ID of 42:

[a-z-listing display="terms" taxonomy="category" parent-term="42"]

To show terms from the Categories taxonomy that are children of any depth in the tree below the term with ID of 42:

[a-z-listing display="terms" taxonomy="category" parent-term="42" get-all-children="yes"]

To override the alphabet used by the plugin:

[a-z-listing display="posts" alphabet="Aa,Bb,Cc,Dd,Ee,Ff,Gg,Hh,Ii,Jj,Kk,Ll,Mm,Nn,Oo,Pp,Qq,Rr,Ss,Tt,Uu,Vv,Ww,Xx,Yy,Zz"]

To add numbers to the listing:

[a-z-listing display="posts" numbers="after"]

The numbers can also be shown before the alphabet:

[a-z-listing display="posts" numbers="before"]

You can group the numbers into a single collection for all posts beginning with a numeral:

[a-z-listing numbers="after" group-numbers="yes"]

To group the alphabet letters into a range:

[a-z-listing grouping="3"]

** The arguments are all optional **

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 or terms.
  • Any value other than posts or terms 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 or after.
  • Any value other than before or after 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 value numbers.
  • 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 together A, B, and C into A-C. Likewise for D-F, G-I and so-on.
  • When using this setting, if numbers are also shown via the numbers="before" or numbers="after" attribute then they will be shown as a single separate group 0-9.
  • When set to the value numbers it will group numerals into a single group 0-9.
  • This requires the numbers to be displayed via the numbers="before" or numbers="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, or 1 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, or 1 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, or 1 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, or letters to show only the letters without any items (posts or terms).

PHP

Synopsis

<?php
the_a_z_listing( $query ); // or
get_the_a_z_listing( $query );
?>

Where $query is one of the following:

• any valid WP_Query parameter array
• a WP_Query object formed from new WP_Query();
• any valid get_pages() parameter array. This array must include a child_of key or a parent key to tell the plugin that it is a get_pages() query
• a single string containing a taxonomy which will switch the listing to display terms from that taxonomy instead of posts

Reference

Full API documentation is available at A-Z-Listing Reference

Multiple Column Output

Multiple column layout is the default on wide screens. A letter’s group of items must contain at least 15 items to create two or more columns. This is to provide a more aesthetically pleasing view when a list is short with only a few items.

Templates and Theming

The plugin allows the site owner, developer, or themer to provide custom templates for the A-Z Listing output.

NOTE: These functions have changed name and method of access in 1.0.0. We have dropped the _a_z_ moniker in the function name and within the template file they are accessed via the $a_z_listing object. The former function names are still accessible, but are largely deprecated.

To add a template to your theme, you need a file similar to the templates/a-z-listing.php file in the plugin folder. Your copy needs to be placed within your theme at the theme root directory and called a-z-listing.php or a-z-listing-section.php (where -section is an optional top-level page slug for the section-targeting feature).

The Loop

The theme system this plugin implements is very similar to the standard WordPress loop, with a few added bits.

Important functions to use in your template are as follows:

• $a_z_query->the_letters() prints the full alphabet, and links the letters that have posts to their section within the index page.
• $a_z_query->have_letters() returns true or false depending on whether there are any letters left to loop-through. This is part of the Letter Loop.
• $a_z_query->have_items() behaves very similarly to Core’s have_posts() function. It is part of the Item Loop.
• $a_z_query->the_letter() similar to Core’s the_post(), this will set-up the next iteration of the A-Z Listing’s Letter Loop. This needs to wrap-around the Item Loop.
• $a_z_query->the_item() similar to Core’s the_post(), this will set-up the next iteration of the A-Z Listing’s Item Loop, the same way the normal WordPress Loop works. This needs to be within the Letter Loop.

When you are within the Item Loop you may utilise all in-built WordPress Core post-related functions such as the_content(). Note that titles and permalinks have helper functions to cope with the A-Z Listing showing taxonomy terms (see the next section).

I advise that you start with a copy of the default template template when customizing your own version. The supplied templates show the usage of most of the functions this plugin provides.

Helper functions

The plugin supports displaying taxonomy terms as though each term were a post. This means that the WordPress functions related to posts such as the_title() and the_permalink() are unreliable. We have therefore added helper functions which will return or print the correct output for the item.

NOTE: These functions have changed name and method of access in 1.0.0. We have dropped the a_z moniker in the function name and within the template file they are accessed via the $a_z_listing object. The previous function names are still accessible, but are largely deprecated.

These helper functions cope with the dual usage of the plugin supporting both WP_Query-based (returning WP_Post objects) and Taxonomy Terms (returning WP_Term objects) listings. These are:

• $a_z_query->the_title() – prints the current item’s Title
• $a_z_query->get_the_title() returns the current item’s Title but does not print it directly
• $a_z_query->the_permalink() prints the current item’s Permalink
• $a_z_query->get_the_permalink() returns the current item’s Permalink but does not print it directly