=== Post Type Archive Descriptions ===
Contributors: mrwweb
Donate link: https://cash.me/$MRWweb
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-3.0.html
Tags: custom post type, custom post types, post type archive, archives, custom post type archive
Requires at least: 3.1
Tested up to: 4.7
Stable tag: 1.1.2

== Description ==

Enables an editable description for a post type to display at the top of the post type archive page. Works just like a taxonomy term description.

Automatically works for any theme that uses `the_archive_description()` (added in WordPress 4.1) like [Twenty Fifteen](https://wordpress.org/themes/twentyfifteen/), [Twenty Sixteen](https://wordpress.org/themes/twentysixteen/), [Twenty Seventeen](https://wordpress.org/themes/twentyseventeen/) or recent [_s-based themes](https://underscores.me).

Also comes with a specific template tag—`ptad_the_post_type_description()` and `ptad_get_post_type_description()`—for other themes.

= Other Plugins by MRWweb =

* [Feature a Page Widget](http://wordpress.org/plugins/feature-a-page-widget/) - Feature a single page in any sidebar.
* [MRW Web Design Simple TinyMCE](https://wordpress.org/plugins/mrw-web-design-simple-tinymce/) - Get rid of bad and obscure TinyMCE buttons. Move the rest to a single top row.
* [Post Status Menu Items](http://wordpress.org/plugins/post-status-menu-items/) - Adds post status links–e.g. "Draft" (7)–to post type admin menus.

== Installation ==

1. From your WordPress site's dashboard, go to Plugins > Add New.
1. Search for "Post Type Archive Descriptions."
1. Click "Install."
1. Click "Activate."

== Frequently Asked Questions ==

= How do I display a custom post type's description? =

In WordPress 4.1, [`the_archive_description()`](https://developer.wordpress.org/reference/functions/the_archive_description/) and [`get_the_archive_description()`](https://developer.wordpress.org/reference/functions/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

== Screenshots ==

1. The editing interface for writing a post type archive description. This plugin adds the "Archive Description" link in the left menu, the "View Books Archive" link in the admin bar, and, of course, the field to save the description.

2. The post type archive description displayed (automatically!) in the Twenty Fifteen theme. The plugin also adds the "Edit Books Description" link.

== Changelog ==
= 1.1.2 (April 25, 2017) =
* [Fix] Only show "Edit Description" admin bar link if user has correct permissions
* [Docs] Clarify one function's inline documentation

= 1.1.1 (April 18, 2016) =
* [Fix] Typo resulted in error and broken qTranslate-X support.

= 1.1.0 (March 30, 2016) =
* [New] New `ptad_wp_editor_settings` filter to modify Post Type Description TinyMCE settings. Thank you [@katanyan](https://profiles.wordpress.org/katanyan).
* [New] Support for qTranslate-X. Thank you to [@Tusko on GitHub](https://github.com/Tusko).

= 1.0.0 (May 14, 2015) =
* Initial release.
* Forked from [CPT Descriptions](https://wordpress.org/plugins/cpt-descriptions/)

== Upgrade Notice == 
= 1.1.1 =
Resolve error. Fix qTranslate-X support.

= 1.1.0 =
New filter for editor settings and qTranslate-X support.

= 1.0.0 =
Let's do this! 