get_the_archive_description

Filter Hook

Description

Filters the archive description.

Hook Information

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

Hook Parameters

Type	Name	Description
`string`	`$description`	Archive description to be displayed.

Usage Examples

Basic Usage

<?php
// Hook into get_the_archive_description
add_filter('get_the_archive_description', 'my_custom_filter', 10, 1);

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

Source Code Context

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

<?php
1845  	 *
1846  	 * @since 4.1.0
1847  	 *
1848  	 * @param string $description Archive description to be displayed.
1849  	 */
1850  	return apply_filters( 'get_the_archive_description', $description );
1851  }
1852  
1853  /**
1854   * Retrieves the description for a post type archive.
1855   *

PHP Documentation

<?php
/**
	 * Filters the archive description.
	 *
	 * @since 4.1.0
	 *
	 * @param string $description Archive description to be displayed.
	 */

Quick Info

Hook Type: Filter
Parameters: 1
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.