get_the_post_type_description │ filter-hook │ WP 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

Where the hook is called

return apply_filters( 'get_the_post_type_description', $description, $post_type_obj );

Where the hook is used in WordPress

add_filter( $filter, 'wptexturize' );

add_filter( $filter, 'convert_chars' );

add_filter( $filter, 'wpautop' );

add_filter( $filter, 'shortcode_unautop' );