Ticket #16784: 16784.diff

wp-includes/general-template.php

@@ -1031 +1031 @@
 }
 
 /**
+ * Display or retrieve description for a post type archive.
+ *
+ * This is optimized for archive.php and archive-{$post_type}.php template files
+ * for displaying the description of the post type.
+ *
+ * @since 4.4.0
+ *
+ * @param bool $display Optional, default is true. Whether to display or retrieve description.
+ * @return string|null Description when retrieving, null when displaying or failure.
+ */
+function post_type_archive_description( $display = true ) {
+        if ( ! is_post_type_archive() ) {
+                return;
+        }
+
+        $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 );
+        /**
+         * Filter the post type archive description.
+         *
+         * @since 4.4.0
+         *
+         * @param string $post_type_description Post type 'description' argument.
+         * @param string $post_type             Post type.
+         */
+        $description = apply_filters( 'post_type_archive_description', $post_type_obj->description, $post_type );
+
+        if ( $display ) {
+                echo $description;
+        } else {
+                return $description;
+        }
+}
+
+/**
  * Display or retrieve page title for category archive.
  *
  * This is useful for category template file or files, because it is optimized