Changeset 40976 for trunk/src/wp-includes/general-template.php

Timestamp:

07/01/2017 05:14:18 AM (7 years ago)

Author:

DrewAPicture

Message:

General: Add support for the post type archive description to get_the_archive_description(), and thereby also the_archive_description().

Props henrywright.
Fixes #38487.

File:

• trunk/src/wp-includes/general-template.php (modified) (2 diffs)

trunk/src/wp-includes/general-template.php

@@ -1541 +1541 @@
 
 /**
- * Retrieve category, tag, term, or author description.
+ * Retrieves the description for an author, post type, or term archive.
  *
  * @since 4.1.0
  * @since 4.7.0 Added support for author archives.
+ * @since 4.9.0 Added support for post type archives.
  *
  * @see term_description()
@@ -1551 +1552 @@
  */
 function get_the_archive_description() {
+    $description = '';
+
     if ( is_author() ) {
         $description = get_the_author_meta( 'description' );
+    } elseif ( is_post_type_archive() ) {
+        $post_type = get_query_var( 'post_type' );
+
+        if ( is_array( $post_type ) ) {
+            $post_type = reset( $post_type );
+        }
+
+        $post_type_obj = get_post_type_object( $post_type );
+
+        // Check if a description is set.
+        if ( isset( $post_type_obj->description ) ) {
+            $description = $post_type_obj->description;
+        }
     } else {
         $description = term_description();