FAQ

Is this plugin compatible with WordPress 5.0 / “Gutenberg”?

Yes. The plugin does not directly integrate with the post editor screen so no changes were required.

Be aware that as of 5 Dec 2019, it appears the Twenty Nineteen theme will not support post type archive descriptions by default. Unless something changes, you will need to manually add support for them in a child theme if using Twenty Nineteen. See the next FAQ for how to do that.

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

Use the_archive_description() or get_the_archive_description().

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

As of v1.3.0 of this plugin, the archive description is automatically added to The Events Calendar archive pages using the plugin’s latest design.

Which post types get a description?

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

Are there filters & actions to modify the plugin?

Yes. Plenty!

Filters:

• 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_admin_parent – Change parent page of the Description edit page
• 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
• ptad_tribe_template_before_include – Modify which The Events Calendar template part the description should appear before, or false to disable automatic output.

Actions:

• ptad_before_editor – Between title and description editor for ALL admin pages. Receives $post_type arg.
• ptad_before_editor_{post_type} – Between title and description editor for any specific post type.
• ptad_after_editor – Immediately below description editor for ALL admin pages. Receives $post_type arg.
• ptad_after_editor_{post_type} – Immediately below description editor for any specific post type.