get_the_archive_description(): string

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

Description

See also

Return

string Archive description.

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

Hooks

apply_filters( ‘get_the_archive_description’, string $description )

Filters the archive description.

Changelog

VersionDescription
4.9.0Added support for post type archives.
4.7.0Added support for author archives.
4.1.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.