get_the_post_type_description filter-hookWP 4.9.0

Filters the description for a post type archive.

Usage

add_filter( 'get_the_post_type_description', 'wp_kama_get_the_post_type_description_filter', 10, 2 );

/**
 * Function for `get_the_post_type_description` filter-hook.
 * 
 * @param string       $description   The post type description.
 * @param WP_Post_Type $post_type_obj The post type object.
 *
 * @return string
 */
function wp_kama_get_the_post_type_description_filter( $description, $post_type_obj ){

	// filter...
	return $description;
}
$description(string)
The post type description.
$post_type_obj(WP_Post_Type)
The post type object.

Changelog

Since 4.9.0 Introduced.

Where the hook is called

get_the_post_type_description()
get_the_post_type_description
wp-includes/general-template.php 1862
return apply_filters( 'get_the_post_type_description', $description, $post_type_obj );

Where the hook is used in WordPress

wp-includes/default-filters.php 166
add_filter( $filter, 'wptexturize' );
wp-includes/default-filters.php 167
add_filter( $filter, 'convert_chars' );
wp-includes/default-filters.php 168
add_filter( $filter, 'wpautop' );
wp-includes/default-filters.php 169
add_filter( $filter, 'shortcode_unautop' );