get_the_archive_description

Retrieve category, tag, term, or author description.

Description

(string) get_the_archive_description(); 

Returns (string)

Archive description.


Usage

  1. if ( !function_exists( 'get_the_archive_description' ) ) { 
  2. require_once ABSPATH . WPINC . '/general-template.php'; 
  3.  
  4.  
  5. // NOTICE! Understand what this does before running. 
  6. $result = get_the_archive_description(); 
  7.  

Defined (1)

The function is defined in the following location(s).

/wp-includes/general-template.php  
  1. function get_the_archive_description() { 
  2. if ( is_author() ) { 
  3. $description = get_the_author_meta( 'description' ); 
  4. } else { 
  5. $description = term_description(); 
  6.  
  7. /** 
  8. * Filters the archive description. 
  9. * @since 4.1.0 
  10. * @param string $description Archive description to be displayed. 
  11. */ 
  12. return apply_filters( 'get_the_archive_description', $description );