get_the_post_type_description() │ WP 4.9.0

Gets the description of the current archive page for the post type.

The description is specified when registering the post type in the description parameter, see the function register_post_type().

The function should be used on the archive page of the post type, see the conditional tag is_post_type_archive().

Uses: get_post_type_object()
1 time — 0.000249 sec (fast) | 50000 times — 0.30 sec (very fast) | PHP 7.1.5, WP 4.9
Hooks from the function

Returns

String. Description of the archive page for the post type.

Usage

get_the_post_type_description();

Examples

0

#1 Display the description of the post type archive 

echo get_the_post_type_description();

Changelog

Since 4.9.0 Introduced.

get_the_post_type_description() code WP 6.9

wp-includes/general-template.php 
function get_the_post_type_description() {
	$post_type = get_query_var( 'post_type' );

	if ( is_array( $post_type ) ) {
		$post_type = reset( $post_type );
	}

	$post_type_obj = get_post_type_object( $post_type );

	// Check if a description is set.
	if ( isset( $post_type_obj->description ) ) {
		$description = $post_type_obj->description;
	} else {
		$description = '';
	}

	/**
	 * Filters the description for a post type archive.
	 *
	 * @since 4.9.0
	 *
	 * @param string       $description   The post type description.
	 * @param WP_Post_Type $post_type_obj The post type object.
	 */
	return apply_filters( 'get_the_post_type_description', $description, $post_type_obj );
}

Archive pages

Custom Types