wp_get_archives

February 12, 2011 by Thorsten 0 Comments

Definition:
function wp_get_archives($args = '') {}

Display archive links based on type and format.

The ‘type’ argument offers a few choices and by default will display monthly archive links. The other options for values are ‘daily’, ‘weekly’, ‘monthly’, ‘yearly’, ‘postbypost’ or ‘alpha’. Both ‘postbypost’ and ‘alpha’ display the same archive link list, the difference between the two is that ‘alpha’ will order by post title and ‘postbypost’ will order by post date.

Parameters

string|array $args: Optional. Override defaults.

Defined filters

getarchives_where
apply_filters( 'getarchives_where', "WHERE post_type = 'post' AND post_status = 'publish'", $r )
getarchives_join
apply_filters( 'getarchives_join', '', $r )
the_title
apply_filters( 'the_title', $arcresult->post_title, $arcresult->ID )

Source code

function wp_get_archives($args = '') {

	global $wpdb, $wp_locale;



	$defaults = array(

		'type' => 'monthly', 'limit' => '',

		'format' => 'html', 'before' => '',

		'after' => '', 'show_post_count' => false,

		'echo' => 1

	);



	$r = wp_parse_args( $args, $defaults );

	extract( $r, EXTR_SKIP );



	if ( '' == $type )

		$type = 'monthly';



	if ( '' != $limit ) {

		$limit = absint($limit);

		$limit = ' LIMIT '.$limit;

	}



	// this is what will separate dates on weekly archive links

	$archive_week_separator = '–';



	// over-ride general date format ? 0 = no: use the date format set in Options, 1 = yes: over-ride

	$archive_date_format_over_ride = 0;



	// options for daily archive (only if you over-ride the general date format)

	$archive_day_date_format = 'Y/m/d';



	// options for weekly archive (only if you over-ride the general date format)

	$archive_week_start_date_format = 'Y/m/d';

	$archive_week_end_date_format	= 'Y/m/d';



	if ( !$archive_date_format_over_ride ) {

		$archive_day_date_format = get_option('date_format');

		$archive_week_start_date_format = get_option('date_format');

		$archive_week_end_date_format = get_option('date_format');

	}



	//filters

	$where = apply_filters( 'getarchives_where', "WHERE post_type = 'post' AND post_status = 'publish'", $r );

	$join = apply_filters( 'getarchives_join', '', $r );



	$output = '';



	if ( 'monthly' == $type ) {

		$query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date) ORDER BY post_date DESC $limit";

		$key = md5($query);

		$cache = wp_cache_get( 'wp_get_archives' , 'general');

		if ( !isset( $cache[ $key ] ) ) {

			$arcresults = $wpdb->get_results($query);

			$cache[ $key ] = $arcresults;

			wp_cache_set( 'wp_get_archives', $cache, 'general' );

		} else {

			$arcresults = $cache[ $key ];

		}

		if ( $arcresults ) {

			$afterafter = $after;

			foreach ( (array) $arcresults as $arcresult ) {

				$url = get_month_link( $arcresult->year, $arcresult->month );

				/* translators: 1: month name, 2: 4-digit year */

				$text = sprintf(__('%1$s %2$d'), $wp_locale->get_month($arcresult->month), $arcresult->year);

				if ( $show_post_count )

					$after = '&nbsp;('.$arcresult->posts.')' . $afterafter;

				$output .= get_archives_link($url, $text, $format, $before, $after);

			}

		}

	} elseif ('yearly' == $type) {

		$query = "SELECT YEAR(post_date) AS `year`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date) ORDER BY post_date DESC $limit";

		$key = md5($query);

		$cache = wp_cache_get( 'wp_get_archives' , 'general');

		if ( !isset( $cache[ $key ] ) ) {

			$arcresults = $wpdb->get_results($query);

			$cache[ $key ] = $arcresults;

			wp_cache_set( 'wp_get_archives', $cache, 'general' );

		} else {

			$arcresults = $cache[ $key ];

		}

		if ($arcresults) {

			$afterafter = $after;

			foreach ( (array) $arcresults as $arcresult) {

				$url = get_year_link($arcresult->year);

				$text = sprintf('%d', $arcresult->year);

				if ($show_post_count)

					$after = '&nbsp;('.$arcresult->posts.')' . $afterafter;

				$output .= get_archives_link($url, $text, $format, $before, $after);

			}

		}

	} elseif ( 'daily' == $type ) {

		$query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, DAYOFMONTH(post_date) AS `dayofmonth`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date), DAYOFMONTH(post_date) ORDER BY post_date DESC $limit";

		$key = md5($query);

		$cache = wp_cache_get( 'wp_get_archives' , 'general');

		if ( !isset( $cache[ $key ] ) ) {

			$arcresults = $wpdb->get_results($query);

			$cache[ $key ] = $arcresults;

			wp_cache_set( 'wp_get_archives', $cache, 'general' );

		} else {

			$arcresults = $cache[ $key ];

		}

		if ( $arcresults ) {

			$afterafter = $after;

			foreach ( (array) $arcresults as $arcresult ) {

				$url	= get_day_link($arcresult->year, $arcresult->month, $arcresult->dayofmonth);

				$date = sprintf('%1$d-%2$02d-%3$02d 00:00:00', $arcresult->year, $arcresult->month, $arcresult->dayofmonth);

				$text = mysql2date($archive_day_date_format, $date);

				if ($show_post_count)

					$after = '&nbsp;('.$arcresult->posts.')'.$afterafter;

				$output .= get_archives_link($url, $text, $format, $before, $after);

			}

		}

	} elseif ( 'weekly' == $type ) {

		$week = _wp_mysql_week( '`post_date`' );

		$query = "SELECT DISTINCT $week AS `week`, YEAR( `post_date` ) AS `yr`, DATE_FORMAT( `post_date`, '%Y-%m-%d' ) AS `yyyymmdd`, count( `ID` ) AS `posts` FROM `$wpdb->posts` $join $where GROUP BY $week, YEAR( `post_date` ) ORDER BY `post_date` DESC $limit";

		$key = md5($query);

		$cache = wp_cache_get( 'wp_get_archives' , 'general');

		if ( !isset( $cache[ $key ] ) ) {

			$arcresults = $wpdb->get_results($query);

			$cache[ $key ] = $arcresults;

			wp_cache_set( 'wp_get_archives', $cache, 'general' );

		} else {

			$arcresults = $cache[ $key ];

		}

		$arc_w_last = '';

		$afterafter = $after;

		if ( $arcresults ) {

				foreach ( (array) $arcresults as $arcresult ) {

					if ( $arcresult->week != $arc_w_last ) {

						$arc_year = $arcresult->yr;

						$arc_w_last = $arcresult->week;

						$arc_week = get_weekstartend($arcresult->yyyymmdd, get_option('start_of_week'));

						$arc_week_start = date_i18n($archive_week_start_date_format, $arc_week['start']);

						$arc_week_end = date_i18n($archive_week_end_date_format, $arc_week['end']);

						$url  = sprintf('%1$s/%2$s%3$sm%4$s%5$s%6$sw%7$s%8$d', home_url(), '', '?', '=', $arc_year, '&amp;', '=', $arcresult->week);

						$text = $arc_week_start . $archive_week_separator . $arc_week_end;

						if ($show_post_count)

							$after = '&nbsp;('.$arcresult->posts.')'.$afterafter;

						$output .= get_archives_link($url, $text, $format, $before, $after);

					}

				}

		}

	} elseif ( ( 'postbypost' == $type ) || ('alpha' == $type) ) {

		$orderby = ('alpha' == $type) ? 'post_title ASC ' : 'post_date DESC ';

		$query = "SELECT * FROM $wpdb->posts $join $where ORDER BY $orderby $limit";

		$key = md5($query);

		$cache = wp_cache_get( 'wp_get_archives' , 'general');

		if ( !isset( $cache[ $key ] ) ) {

			$arcresults = $wpdb->get_results($query);

			$cache[ $key ] = $arcresults;

			wp_cache_set( 'wp_get_archives', $cache, 'general' );

		} else {

			$arcresults = $cache[ $key ];

		}

		if ( $arcresults ) {

			foreach ( (array) $arcresults as $arcresult ) {

				if ( $arcresult->post_date != '0000-00-00 00:00:00' ) {

					$url  = get_permalink( $arcresult );

					if ( $arcresult->post_title )

						$text = strip_tags( apply_filters( 'the_title', $arcresult->post_title, $arcresult->ID ) );

					else

						$text = $arcresult->ID;

					$output .= get_archives_link($url, $text, $format, $before, $after);

				}

			}

		}

	}

	if ( $echo )

		echo $output;

	else

		return $output;

}

3677

/wp-includes/general-template.php, Documentation, Files, Filters, Filters by letter g, Filters by letter t, Functions, Functions by letter w

codex, getarchives_join, getarchives_where, id5be784bcaa1c840d25b593e47f38f883, the_title, wp_get_archives

wp_generator

wp_get_associated_nav_menu_items

No comments yet... Be the first to leave a reply!

Ouch, we don’t have this here!

It seems that we do not have anything about this topic here, but you might want to do one of the following. If you were searching for a php function head over to the php manual and use one of their entry points

If you were searching for a WordPress related topic and did not find it here try one of the following options.

Use the search form in the navigation bar above
Use the WordPress search

If nothing like this helps try using Google or an other search engine

Google
Bing

Golden Q&A rules

Search first

Be sure that you first search in Google, the WordPress forums, Codex or this site ( using the form in the menu ). Sharing your previous results helps narrowing down the problem if you also tell us what you found and why it didn’t serve your needs.

Be specific

Give as much details about your problem as possible. Make sure to include examples, links and context related to your problem.

Be WordPress related

This site focuses on WordPress and related topics. Please make sure that your question is related to WordPress code, functionality or other related topics.

Be nice

Please keep in mind that this is a voluntary service. Answers might not always be correct or what you expect. Please be nice and let us know if any inappropriate answers come to your attention.

Latest
Popular
Comments

Speed up WordPress when you have a lot of terms February 15, 2014
WordPress Importer with remote lookup for assets. February 15, 2014
It’s been a while! Sorry for neglecting you! September 4, 2013
Cache posts in category/tag/taxonomy for better performing content blocks May 10, 2012
Lost in time(zones)? http://localtime.at can help May 5, 2012

WordPress Syntax mode for Panic Coda February 18, 2011
wp_tiny_mce February 12, 2011
Initialize WordPress from a PHP CLI script July 22, 2011
wp_save_image February 12, 2011
Caching WordPress navigation menus – wp_nav_menu() wrapper October 7, 2011