Archive-Pro-Matic | Documentation
Shortcode Attributes
Archive-Pro-Matic includes two shortcodes to include an archive list on a post or page: [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: Archive-Pro-Matic.
Attributes
Pro Only
Cat ID Attribute
Use the cat_id attribute to display an archive list filtered by single or multiple categories. Attribute accepts a single category ID or a comma separated string of multiple category IDs. Using a negative category ID value will omit the category.
Example
[archives type="monthly" cat_id="55,43" limit="10" /]Type Attribute
Type of archive to retrieve. The following values are accepted by the type attribute:
Pro Only
- quarterly (pro only)
- seasonally (pro only)
Daily
[archives type="daily"/]Weekly
[archives type="weekly"/]Monthly
[archives type="monthly"/]Yearly (default)
[archives type="yearly"/]Post By Post
[archives type="postbypost"/]Alpha
[archives type="alpha"/]Pro Only
Quarterly (pro only)
[archives type="quarterly"/]Seasonally (pro only)
[archives type="seasonally"/]Alpha vs Post-by-Post
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.
Pro Only
Cat Attribute
Use the cat attribute to display an archive list filtered by single category. Attribute accepts a single category slug.
Example
[archives type="monthly" cat="monkey"/]Limit Attribute
The limit attribute controls the number of results displayed.
Example
[archives limit="2"/]Pro Only
Taxonomy Attribute
The taxonomy attribute is used to select all posts that have a specific taxonomy defined. The term attribute can be added to limit the results to a specific taxonomy.
Examples
Show an archive of all posts that have at least one post tag:
[archives type="monthly" taxonomy="post_tag"/]Show an archive of all posts that have at least one category:
[archives type="monthly" taxonomy="category"/]Order Attribute
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.
Example
[archives type="yearly" order="ASC"/]Alpha Order Attribute
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"]Pro Only
Term Attribute
The term attribute is used with the taxonomy attribute to display an archive of posts from a single taxonomy.
Example
Only show an archive of posts that have been tagged with ‘monkey’:
[archives type="monthly" taxonomy="post_tag" term="monkey"/]Post Order Attribute
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.
Examples
[archives type="postbypost" limit="3"][archives type="postbypost" post_order="ASC" limit="3"]Pro Only
Date Format Attribute
Use the date_format attribute to adjust the way dates are displayed in the archive list. See the php date function for format parameters.
Example
[archives limit="3" date_format="Y. F"/]Post Type Attribute
List archives by a custom post type. Default is ‘post’.
Example
[archives limit="3" post_type="monkey"/]Pro Only
Highlight Attribute
Use the highlight attribute on yearly type archives to assign a special class to the current and/or active year in an archive list. Valid values for the highlight attribute are:
- active-year
- current-year
- active-year, current-year
- active-season
Including ‘current-year’ in the value of the highlight attribute will add a current-year class to the current year in the archive list. If ‘active-year’ is included, the archive year that is currently being viewed will be assigned a active-year class. Note: This class is only assigned to the active year when viewed on a yearly archive page.
If active-season highlighting is used on a seasonally archive type that is also using a option format (drop-down select), the active year+season will be automatically selected.
Examples
CSS:
.current-year a {
color: #ff0000;
}Shortcode:
[archives type="yearly" highlight="current-year"/]Active Season Highlighting:
[archives type="seasonally" format="option" sub_options="true" sep=" - " highlight="active-season"/]Pro Only
Alpha Headings Attribute
Add an alphabet heading for each letter group when using alpha type archives. Valid values are:
- 1 (true)
- 0 (false) – default
Example
[archives type="alpha" limit="5" alpha_headings="1"/]Format Attribute
The format to display the archive list. Default value is ‘html’. Valid values for the format attribute are:
- html – (default) display the archive as an unordered list using li tags
- option – display the archive as a select or drop-down form element
- link – display the archive as an unordered list using link tags
- custom – display a custom list using the before and after attributes
Example
[archives format="option"/]See WordPress codex for more detail on format parameters.
Pro Only
Alpha Tag Attribute
HTML tag to wrap the alpha heading when using alpha type archives.
Example
[archives type="alpha" limit="5" alpha_headings="1" alpha_tag="h4"/]Before Attribute
Text to place before the link when using html or custom format options. There is no default.
Example
[archives type="yearly" limit="3" before="archives for: "/]Pro Only
All Is Link Attribute
Use the all_is_link attribute to included any text added using the ‘before’ and ‘after’ attributes as part of the archive link. Valid values are:
- 1 (true)
- 0 (false) – default
Example
[archives limit="3" before="++" after="++" all_is_link="1"/]After Attribute
Text to place after the link when using html or custom format options. There is no default.
Example
[archives type="yearly" limit="3" after=" was a good year"/]Pro Only
Sub Options Attribute
the sub_options attribute is used to create add a sub-select in the archive list. For example, setting ‘true’ for a seasonally archive will present a year link on a seperate line, with the seasonal sub archives listed below. If the sub_options is set to ‘block’ the both the main and sub elements will appear on the same line.
Examples
Using sub_options to break out seasons or quarters on a seperate line:
[archives type="seasonally" sub_options="true" /][archives type="quarterly" sub_options="true" /]See Archive-Pro-Matic – Quarterly and Seasonal Archives.
Using sub_options to do display all links on the same line and create a unique ‘block’ style archive:
[archives type="monthly" sub_options="block" /]
Archive-Pro-Matic Block Style Archives
See Advanced Monthly Sub Archives.
Select Text Attribute
The select_text attribute is used to change the default text that is displayed as the default selected value when using the option format.
Example
[archives limit="5" format="option" select_text="Choose Wisely"/]Pro Only
Sep Attribute
The sep attribute can be defined to give more separation between the year and the sub-options.
Example
[archives type="seasonally" sub_options="true" sep=" -- " /]Showcount Attribute (depreciated)
This attribute has been depreciated, use the show_post_count attribute instead.
Show Post Count Attribute
Display the number of posts in an archive. For use with all archive types except ‘alpha’ and ‘postbypost’. Valid values are:
- 1 (true)
- 0 (false) – default
Examples
[archives limit="3" show_post_count="true"/][archives limit="3" show_post_count="1"/]Pro Only
Show Empty Attribute
Set the show_empty attribute to true to allow placeholders to be displayed for empty archives. The show_empty attribute currently only works with monthly archives with the ‘year/month’ sub_options activated.
Example
[archives type="monthly" sub_options="true" show_empty="true" /]Tag Attribute
Controls the list type to be use in ‘html’ and ‘link’ type archives. Any valid HTML tag may be used.
- ol – ordered list
- ul – unordered list (default)
- div – useful for block-type archives
[archives limit="3" tag="ol"/]