get_the_archive_description() WordPress Function
The get_the_archive_description() function returns the description for the current archive view. This is typically used on category and tag archive pages.
get_the_archive_description() #
Retrieves the description for an author, post type, or term archive.
Description
See also
Return
(string) Archive description.
Source
File: wp-includes/general-template.php
function get_the_archive_description() { if ( is_author() ) { $description = get_the_author_meta( 'description' ); } elseif ( is_post_type_archive() ) { $description = get_the_post_type_description(); } else { $description = term_description(); } /** * Filters the archive description. * * @since 4.1.0 * * @param string $description Archive description to be displayed. */ return apply_filters( 'get_the_archive_description', $description ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
4.9.0 | Added support for post type archives. |
4.7.0 | Added support for author archives. |
4.1.0 | Introduced. |