get_the_post_type_description

Filter Hook

Description

Filters the description for a post type archive.

Hook Information

File Location	`wp-includes/general-template.php` View on GitHub
Hook Type	Filter
Line Number	`1884`

Hook Parameters

Type	Name	Description
`string`	`$description`	The post type description.
`WP_Post_Type`	`$post_type_obj`	The post type object.

Usage Examples

Basic Usage

<?php
// Hook into get_the_post_type_description
add_filter('get_the_post_type_description', 'my_custom_filter', 10, 2);

function my_custom_filter($description, $post_type_obj) {
    // Your custom filtering logic here
    return $description;
}

Source Code Context

wp-includes/general-template.php:1884 - How this hook is used in WordPress core

<?php
1879  	 * @since 4.9.0
1880  	 *
1881  	 * @param string       $description   The post type description.
1882  	 * @param WP_Post_Type $post_type_obj The post type object.
1883  	 */
1884  	return apply_filters( 'get_the_post_type_description', $description, $post_type_obj );
1885  }
1886  
1887  /**
1888   * Retrieves archive link content based on predefined or custom code.
1889   *

PHP Documentation

<?php
/**
	 * 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.
	 */

Quick Info

Hook Type: Filter
Parameters: 2
File: wp-includes/general-template.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.