Documentation

Brand: Twinpictures Plugin Oven | Category: WordPress Plugin | Updated: 28 April, 2020

Shortcode

Annual Archive can also be used in posts and pages simply by including the

shortcode. The following attributes can be defined to customize the way the archive is rendered:

Type Attribute

[archives type="daily" /]
[archives type="weekly" /]
[archives type="monthly" /]
[archives type="yearly" /]
[archives type="decade" /]
[archives type="postbypost" /]
[archives type="alpha" /]

Limit Attribute

The limit attribute controls the number of results displayed.

[archives type="monthly" limit="3" /]

Order Attribute

The order attribute controls the sort order. The only valid values is DESC and ASC. Descending (DESC) is the default.

[archives type="yearly" order="ASC" /]

Alpha Order

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.

Examples

[archives type="alpha" limit="3"]
[archives type="alpha" alpha_order="DESC" limit="3"]

Format Attribute

[archives type="monthly" limit="7" format="option" /]

Supported format value options are:

  • html – In HTML list (<li>) tags and before and after strings. This is the default.
  • option – In select (<select>) or dropdown option (<option>) tags.
  • link – Within link (<link>) tags.
  • custom – Custom list using the before and after strings.

Before Attribute

Text to place before the link when using ‘html’ or ‘custom’ format options. There is no default.

After Attribute

Text to place after the link when using ‘html’ or ‘custom’ format options. There is no default.

Select Text Attribute

[archives type="monthly" limit="7" format="option" select_text="Choose Wisely" /]

The select_text attribute is used to change the default text that shows up as the default selected value when using the option format.

Showcount Attribute (deprecated)

Depreciated. Use show_post_count.

Show_Post_Count Attribute

[archives type="monthly" limit="7" show_post_count="true" /]

Display number of posts in an archive (true) or do not (default). For use with all type values except ‘postbypost’. Replaces the depreciated showcount attribute to keep more inline with the wp_get_archives parameters.

Tag Attribute

[archives type="monthly" limit="7" tag="OL" /]

  1. February 2019
  2. October 2018
  3. February 2018
  4. November 2017
  5. March 2015
  6. January 2015
  7. November 2014

Defines the list type to use. Options are UL (default) and OL

Post_Type Attribute

Post Types are supported as of Annual Archive version 1.4.8. To list an archive of a specific custom post type, using the post_type attribute like so:

[archives type="monthly" post_type="the_post_type_slug" /]

Advanced Examples and Tests

Further examples and demonstrations are available on our test server under the Annual-Archive category.