get_the_post_type_description

The timeline below displays how wordpress function get_the_post_type_description has changed across different WordPress versions. If a version is not listed, refer to the next available version below.

WordPress Version: 4.9

/**
 * Retrieves the description for a post type archive.
 *
 * @since 4.9.0
 *
 * @return string The post type description.
 */
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);
}