Changeset 41232

Timestamp:

08/04/17 23:00:50 (10 hours ago)

Author:

johnbillion

Message:

Formatting: Introduce get_the_post_type_description() to allow post type archive descriptions to be formatted the same as author and term archives.

Props henry.wright

Fixes #40040

Location:

trunk/src/wp-includes

Files:

• default-filters.php (modified) (1 diff)
• general-template.php (modified) (2 diffs)

trunk/src/wp-includes/default-filters.php

@@ -115 +115 @@
 
 // Format text area for display.
-foreach ( array( 'term_description', 'get_the_author_description' ) as $filter ) {
+foreach ( array( 'term_description', 'get_the_author_description', 'get_the_post_type_description' ) as $filter ) {
     add_filter( $filter, 'wptexturize'      );
     add_filter( $filter, 'convert_chars'    );

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

@@ -1555 +1555 @@
         $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 = '';
-        }
+        $description = get_the_post_type_description();
     } else {
         $description = term_description();
@@ -1581 +1568 @@
      */
     return apply_filters( 'get_the_archive_description', $description );
+}
+
+/**
+ * Retrieves the description for a post type archive.
+ *
+ * @since 4.9.0
+ *
+ * @return string The post type description.
+ */
+function get_the_post_type_description() {
+    $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 = '';
+    }
+
+    /**
+     * 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.
+     */
+    return apply_filters( 'get_the_post_type_description', $description, $post_type_obj );
 }