Annual Archive | Documentation
Shortcode Attributes
Shortcode Attributes
Annual Archive includes two shortcodes: [archives]
and in case ‘archives’ is already in use by another plugin or theme, [arcpromat]
may be used instead.
Below is a full list of all shortcode attributes that can be used to customize the archive list. Further examples and demonstrations of the latest features can be found on our testing site under the category: Annual-Archive.
Type of archive to retrieve. The following values are accepted by the type attribute:
[archives type="daily"/]
[archives type="weekly"/]
[archives type="monthly"/]
[archives type="yearly"/]
[archives type="postbypost"/]
[archives type="alpha"/]
The alpha and postbypost archive types both display a list of post titles instead of dates. The difference between alpha and postbypost is that alpha orders the archive by post title and postbypost orders by post date.
The limit attribute controls the number of results displayed.
[archives limit="2"/]
The order attribute controls the sort order of all post types except alpha and postbypost. Valid values are DESC and ASC. Descending (DESC) is the default value.
[archives type="yearly" order="ASC"/]
By default alpha lists are displayed A->Z ascending. To reverse the order of alpha archive type the alpha_order attributes must be set to DESC.
[archives type="alpha" limit="3"]
[archives type="alpha" alpha_order="DESC" limit="3"]
By default postbypost archive types are displayed by date, newest to oldest descending. To change the order of an postbypost archive type the post_order attributes must be set to ASC.
[archives type="postbypost" limit="3"]
[archives type="postbypost" post_order="ASC" limit="3"]
List archives by a custom post type. Default is ‘post’.
[archives limit="3" post_type="monkey"/]
The format to display the archive list. Default value is ‘html’. Valid values for the format attribute are:
[archives format="option"/]
See WordPress codex for more detail on format parameters.
Text to place before the link when using html or custom format options. There is no default.
[archives type="yearly" limit="3" before="archives for: "/]
Text to place after the link when using html or custom format options. There is no default.
[archives type="yearly" limit="3" after=" was a good year"/]
The select_text attribute is used to change the default text that is displayed as the default selected value when using the option format.
[archives limit="5" format="option" select_text="Choose Wisely"/]
This attribute has been depreciated, use the show_post_count attribute instead.
Display the number of posts in an archive. For use with all archive types except ‘alpha’ and ‘postbypost’. Valid values are:
[archives limit="3" show_post_count="true"/]
[archives limit="3" show_post_count="1"/]
Controls the list type to be use in ‘html’ and ‘link’ type archives. Any valid HTML tag may be used.
[archives limit="3" tag="ol"/]