A WordPress-centric search engine for devs and theme authors



get_the_archive_description ›

Since4.1.0
Deprecatedn/a
get_the_archive_description ( No parameters )
See:
Returns:
  • (string) Archive description.
Defined at:
Codex:
Change Log:
  • 4.7.0
  • 4.9.0

Retrieves the description for an author, post type, or term archive.



Source

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 );
}