the_archive_description() doesn't output the custom post type description when used in a post type archive template

[henry.wright]

When registering a custom post type using register_post_type(), we can provide a CPT description using the description param.

If the_archive_description() is used in a custom post type archive template, the CPT description doesn't get outputted.

[swissspidy]

Related: #37535

[swb1192]

Is there a workaround for this?

[swissspidy]

@swb1192 the_archive_description() has a filter that you can use to display the post type description yourself.

[henry.wright]

Further to @swissspidy's post above, you may need is_post_type_archive() if your filter function is in a plugin or in your functions file.

Ref ​https://codex.wordpress.org/Function_Reference/is_post_type_archive

[henry.wright]

38487.diff will output the custom post description in custom post archives.

[DrewAPicture]

#34656 was marked as a duplicate.

[DrewAPicture]

In 40976:

General: Add support for the post type archive description to get_the_archive_description(), and thereby also the_archive_description().

Props henrywright.
Fixes #38487.

[DrewAPicture]

In 40977:

Remove an unnecessary initialization of $description due to the else condition in get_the_archive_description().

See [40976]. See #38487.

[henry.wright]

Hey @DrewAPicture

In the commit, if post_type_obj->description isn't set, $description doesn't get set. Does that matter?

[DrewAPicture]

Replying to henry.wright:

Hey @DrewAPicture

In the commit, if post_type_obj->description isn't set, $description doesn't get set. Does that matter?

It does matter, yes :-) I removed the initialization thinking that I'd left the fallback from your original patch in there, but I didn't. Good catch.

[DrewAPicture]

In 40983:

General: Ensure $description gets initialized in get_the_archive_description() if the post type archive conditional is true and the description isn't set.

Props henrywright.
See #38487.