17

How do you display the archives of a Custom Post Type by Year & Month?

1

5 Answers 5

17

Yes, you can. All you need is make a filter for wp_get_archives(); so it accepts post_type parameter:

function my_custom_post_type_archive_where($where,$args){  
    $post_type  = isset($args['post_type'])  ? $args['post_type']  : 'post';  
    $where = "WHERE post_type = '$post_type' AND post_status = 'publish'";
    return $where;  
}

then call this:

add_filter( 'getarchives_where','my_custom_post_type_archive_where',10,2);

Whenever you want to display archive by custom post type, just pass the post_type args:

$args = array(
    'post_type'    => 'your_custom_post_type',
    'type'         => 'monthly',
    'echo'         => 0
);
echo '<ul>'.wp_get_archives($args).'</ul>';
4
  • 3
    Did you try this solution? It correctly fetches the list of months with a post from your CPT and the number of posts, but the links are useless. Clicking them takes you to the month for the whole site, not for the CPT.
    – jerclarke
    Commented Sep 21, 2012 at 16:12
  • After some digging (see Tom Nowell's answer below), I gave up on monthly archives for custom post types. Instead, I used a post category, and changed my permalink structure to /%category%/%year%/%monthnum%/%postname%/. Then, it might be possible using a hook similar to above, to modify the links to start with /%category%/ instead of just the date.
    – Kevin C.
    Commented Mar 22, 2013 at 22:31
  • Question on this. This creates urls like: mysite.com/2013/04 but this leads to a 404. The custom post type is available at: mysite.com/cats which makes me think mysite.com/cats/2013/04 would be what the link should be, but this also resolves to a 404. How do you get the archive links to work?
    – gaoshan88
    Commented Apr 11, 2013 at 5:56
  • 2
    Even better, there is finally plugin to deal with this missing functionality in WordPress. It was created by a core contributor trying to fix this issue in the core. The plugin is provided to get us through until the issue is properly addressed in the core. wordpress.org/plugins/archives-for-custom-post-types
    – Trevor
    Commented Jul 9, 2014 at 18:01
6

You don't, the official line from the Wordpress developers was that custom post types weren't intended to do the job of normal ordinary posts, and that if you need post archives of dates etc, then you're not doing things correctly, and you're better off using post formats etc..

Custom post types are intended for web applications etc, whereas doing something such as setting up a custom post type that acts as a secondary or parallel blog with a different name, e.g. blog vs news, with the same abilities, is not what the feature was intended for, and would mean other technical issues arising from its implementation.

If you are still insistent on this, and simply using custom taxonomies and post formats is not enough, you could add rewrite rules in functions.php and redirect year/month archives in certain URLs to the post archive page, and then check on the custom post archive page if you've specified variables in your rewrite rules and load a different template, making sure in your rewrite rules to set the appropriate values.

8
  • It does seem a bit odd that they would only go so far with this functionality. Can you give me an example of how custom posts should be used?
    – Dan Lee
    Commented Nov 17, 2011 at 13:02
  • Custom posts should be used for anything that isn't covered by the scope of pages and blog posts ( or blog posts with a different name but work the same, e.g. articles/news/diary/etc ) Examples of correct uses of custom posts include: events, menus, locations, forms, logs, etc
    – Tom J Nowell
    Commented Nov 17, 2011 at 13:05
  • Custom posts are basically the means of producing web apps, they're not the means of duplicating the post menu in the backend for easier editing ( and such a use would make wordpress much slower and be more of a task than you realise to do )
    – Tom J Nowell
    Commented Nov 17, 2011 at 13:12
  • 1
    UUUUUgh. This is the correct answer to the question tragically. I can't believe that the explanation above is based on "we shouldn't have date URLs for CPTs" though, it is almost definitely "Date URLs for CPTs are too complicated" that is driving the actual decision not to implement. CLEARLY there are cases where people would want date archives for a custom post type, you can't make that obvious desire dissapear by pointing out post formats.
    – jerclarke
    Commented Sep 21, 2012 at 17:36
  • 1
    I have to strongly disagree. Custom post types are meant to be used for whatever you want them to be used for, no where in the Codex does it say they are for "web apps". Also, you may very well need a "news" section which has it's own custom taxonomy and you'd want archives for those. Or even the suggested "events" type, which I agree are a perfect use for CPTs, but again those easily could need date based archives.
    – Trevor
    Commented Jan 2, 2015 at 22:02
5

EDIT -> while this answer still works for < WP4.4, since 4.4 support for Custom Post Types is now included in wp_get_archives()


There finally is a simple, quick and easy solution for date based archives of Custom Post Types in WordPress! This has been a long standing issue that is recorded here in the WP Core Trac.

It has yet to be solved but one of the contributors to the Trac has posted a simple plugin in GitHub that will enable you to have date based archives for CPTs.

After installing this plugin, or adding the code for your functions manually you case use archives for CPTs as such:

<?php wp_get_archives_cpt( 'post_type=custom_post_type' ); ?>

Note this new function wp_get_archives_cpt works the same as the standard wp_get_archives so you can use any of the regular arguments it accepts. However, it simply adds the ability for you to be able to add a custom post type name argument.

0
2

Not enough reputation to add this to taiken's answer sorry.

However wanted to add that his answer did work for me, however the links were in the 'localhost/date/2010' format. Whereas I needed 'localhost/postslug/2010' format. I was able to fix this by using a string replace on the output of wp_get_archives.

So depending on how your permalinks are set this code will fix the 404 problem and redirect the links to the custom post type permalink structure:

$yearly_archive = wp_get_archives(array( 'type' => 'yearly', 'post_type' => '<your post type name>', 'echo' => '0') );
$blog_url = get_bloginfo('url');
echo str_replace(($blog_url . '/date'), ($blog_url . '<your post type slug>'),$yearly_archive);
2

Can't add to takien's post so here's what I ended up having to do:

functions.php

add_action('init', 'my_year_archive_rewrites');  
function my_year_archive_rewrites() {   
    add_rewrite_rule('resource/news/([0-9]{4})/page/?([0-9]{1,})/?', 'index.php?post_type=news&year=$matches[1]&paged=$matches[2]', 'top');
    add_rewrite_rule('resource/news/([0-9]{4})/?', 'index.php?post_type=news&year=$matches[1]', 'top');
}

add_filter('getarchives_where', 'my_custom_post_type_archive_where', 10, 2);
function my_custom_post_type_archive_where($where,$args){  
    $post_type = isset($args['post_type']) ? $args['post_type'] : 'post';  
    return "WHERE post_type = '$post_type' AND post_status = 'publish'";
}

add_filter('year_link', 'my_year_link');
function my_year_link($link) {
    global $wp_rewrite;

    if(true) { // however you determine what archive you want
        $link = str_replace($wp_rewrite->front, '/resource/news/', $link);
    }

    return $link;
}

Calling wp_get_archives()

wp_get_archives(array('post_type'=>'news', 'type'=>'yearly'));
1
  • See his is your first answer. Just a tip when answering questions, don't just add code or for that matter links. Although your code might work, it is always nice to know what your code does and why it should work. Otherwise your answer is nicely formatted. +1 for that Commented Apr 17, 2014 at 16:28

Not the answer you're looking for? Browse other questions tagged or ask your own question.