Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 3.15 KB

README.md

File metadata and controls

65 lines (39 loc) · 3.15 KB
Raw

CPT Archives

A WordPress plugin to manage post type archive titles, descriptions, and permalink slugs from the dashboard.

Description

CPT Archives allows for editing a post type's archive properties by registering a new custom post type called cpt_archive that maps directly to a post type archive and provides an interface for easy management. In fact, since it's really nothing more than a CPT, it can be further extended with plugins to add more meta boxes for customizing your archive pages in new and interesting ways.

Another benefit to this approach is that a new "Archive" meta box appears on the Appearance -> Menus screen, making it easy to add your post type archives to a nav menu without using a custom link. Even if your archive slug does happen to change, you'll no longer have to update the URL in your menu.

Installation

Upload

  1. Download the latest tagged archive (choose the "zip" option).
  2. Go to the Plugins -> Add New screen and click the Upload tab.
  3. Upload the zipped archive directly.
  4. Go to the Plugins screen and click Activate.

Manual

  1. Download the latest tagged archive (choose the "zip" option).
  2. Unzip the archive.
  3. Copy the folder to your /wp-content/plugins/ directory.
  4. Go to the Plugins screen and click Activate.

Check out the Codex for more information about installing plugins manually.

Git

Using git, browse to your /wp-content/plugins/ directory and clone this repository:

git clone [email protected]:bradyvercher/wp-cpt-archives.git

Then go to your Plugins screen and click Activate.

Add Support

To register custom archive support for an existing post type, add a quick snippet to your theme's functions.php file or in a custom plugin like this:

function my_cpt_archives_init() {
     add_post_type_support( 'my_post_type', 'archive' );
}
add_action( 'init', 'my_cpt_archives_init' );

This automatically adds a submenu in the post type's menu that points directly to the archive edit screen. Behind the scenes, when you register support for an archive like this, a new cpt_archive post is created and tied to the post type, so you don't have to do anything else.

If your post type displays as a submenu item itself, you'll probably need to register your own submenu item to edit the archive. A few filters are sprinkled through the plugin to allow changing how you can access these new archive posts.

Template Tags

post_type_archive_title()

Use this standard template tag for displaying the archive title. The plugin filters the output to use whatever title you enter in the dashboard.

post_type_archive_description( $before = '', $after = '' );

This is a custom template tag for displaying the content from the editor in the dashboard. The parameters are optional, but let you specific HTML or text to display before and after the description if one exists. If a description doesn't exist, then nothing will be displayed.

Credits

Built by Brady Vercher
Copyright 2012 Blazer Six, Inc.