WordPress.org

Make WordPress Core

Changeset 41232


Ignore:
Timestamp:
08/04/2017 11:00:50 PM (3 years 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:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/default-filters.php

    r41172 r41232  
    115115
    116116// Format text area for display.
    117 foreach ( array( 'term_description', 'get_the_author_description' ) as $filter ) {
     117foreach ( array( 'term_description', 'get_the_author_description', 'get_the_post_type_description' ) as $filter ) {
    118118    add_filter( $filter, 'wptexturize'      );
    119119    add_filter( $filter, 'convert_chars'    );
  • trunk/src/wp-includes/general-template.php

    r41121 r41232  
    15551555        $description = get_the_author_meta( 'description' );
    15561556    } elseif ( is_post_type_archive() ) {
    1557         $post_type = get_query_var( 'post_type' );
    1558 
    1559         if ( is_array( $post_type ) ) {
    1560             $post_type = reset( $post_type );
    1561         }
    1562 
    1563         $post_type_obj = get_post_type_object( $post_type );
    1564 
    1565         // Check if a description is set.
    1566         if ( isset( $post_type_obj->description ) ) {
    1567             $description = $post_type_obj->description;
    1568         } else {
    1569             $description = '';
    1570         }
     1557        $description = get_the_post_type_description();
    15711558    } else {
    15721559        $description = term_description();
     
    15811568     */
    15821569    return apply_filters( 'get_the_archive_description', $description );
     1570}
     1571
     1572/**
     1573 * Retrieves the description for a post type archive.
     1574 *
     1575 * @since 4.9.0
     1576 *
     1577 * @return string The post type description.
     1578 */
     1579function get_the_post_type_description() {
     1580    $post_type = get_query_var( 'post_type' );
     1581
     1582    if ( is_array( $post_type ) ) {
     1583        $post_type = reset( $post_type );
     1584    }
     1585
     1586    $post_type_obj = get_post_type_object( $post_type );
     1587
     1588    // Check if a description is set.
     1589    if ( isset( $post_type_obj->description ) ) {
     1590        $description = $post_type_obj->description;
     1591    } else {
     1592        $description = '';
     1593    }
     1594
     1595    /**
     1596     * Filters the description for a post type archive.
     1597     *
     1598     * @since 4.9.0
     1599     *
     1600     * @param string       $description   The post type description.
     1601     * @param WP_Post_Type $post_type_obj The post type object.
     1602     */
     1603    return apply_filters( 'get_the_post_type_description', $description, $post_type_obj );
    15831604}
    15841605
Note: See TracChangeset for help on using the changeset viewer.