FAQ

Installation Instructions

1. From your WordPress site’s dashboard, go to Plugins > Add New.
2. Search for “Post Type Archive Descriptions.”
3. Click “Install.”
4. Click “Activate.”

How do I display a custom post type’s description?

In WordPress 4.1, the_archive_description() and get_the_archive_description() were introduced. As long as your theme supports those functions, you don’t have to do anything!

Older themes can use ptad_get_post_type_description() or ptad_the_post_type_description() to return or echo a post type description. Both functions take an optional $post_type slug argument to return a specific post type. However, that is unnecesarry on a page that returns true for is_post_type_archive()`.

Chances are you want this in the archive-{post_type_slug}.php or archive.php template files.

Which post types get a description?

By default, any custom post type (not Posts or Pages) that was registered with 'has_archive' => true. There is a filter (see below) to add support for any post type.

Are there filters to modify the plugin?

Glad you asked. Yes. Plenty!

• ptad_post_types – specify the post types with a description (default is all non-built_in post types where has_archive is true)
• ptad_admin_title – Modify admin page title
• ptad_menu_label – Modify the menu item label in the admin
• ptad_description_capability – Set capability of who can edit descriptions. Default: edit_posts
• ptad_edit_description_link – Modify admin bar link to edit the description
• ptad_view_archive_link – Modify admin bar link to view the post type archive