Retired Documentation: You are using the documentation for version 1.7.3 which was retired in 2013. Go here for the latest version documentation or check here for your available upgrades to the latest version.

Archive Month Links Tag

The Archive Month links tag displays a list of links for any month that contains weblog entries. Its purpose is to link to your monthly archive page. The links created by this tag look like this:

October, 2005
September, 2005
August, 2005
July, 2005
June, 2005

Here is the tag syntax:

{exp:weblog:month_links weblog="news" limit="50"}



{month}, {year}<br />



{/exp:weblog:month_links}

limit=

limit="10"

The number of rows to return.

sort=

sort="asc" sort="desc"

The sort order can be ascending or descending. The order will default to "descending" if nothing is specified.

show_expired=

show_expired="yes"

You can determine whether you wish for entries that have "expired" to be included.

show_future_entries=

show_future_entries="yes"

You can determine whether you wish for entries dated in the "future" to be included. This option is useful when doing things like creating a list of events, some of which have not occurred yet.

status=

status="open"

You may restrict to entries with a particular status . The two statuses "open" and "closed" are default statuses that are always available, so you can always specify those if needed. You can choose multiple statuses using a pipe:

status="draft|reviewed|published"

Or exclude statuses using "not"

status="not submitted|processing|closed"

weblog=

weblog="news"

The name of the weblog you want to limit the query to.

Variables

{month}
{month_num}
{month_short}
{path='weblog/archives'}
{year}
{year_short}

For example, this:

<a href="{path='weblog/archives'}">{month}, {year}</a>

Will be rendered like this:

<a href="example.com/index.php/weblog/archives/2003/12/">December, 2003</a>

Note: The path setting can optionally be enclosed in quotes: {path="template_group/template_name"}

year

{year}

Year, long format: 2003

year_short

{year_short}

Year, short format: 03

Variables Pairs

{year_heading}

year_heading


					{year_heading}

					<p>{year}</p>

				  	{/year_heading}

The year heading can be used to show information once for each year.