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

Props henrywright.
Fixes #38487.

Built from https://develop.svn.wordpress.org/trunk@40976


git-svn-id: http://core.svn.wordpress.org/trunk@40826 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2017-07-01 05:15:46 +00:00
parent 0fe9fb4a16
commit f6b5c794bf
2 changed files with 18 additions and 2 deletions

View File

@ -1540,18 +1540,34 @@ function the_archive_description( $before = '', $after = '' ) {
} }
/** /**
* Retrieve category, tag, term, or author description. * Retrieves the description for an author, post type, or term archive.
* *
* @since 4.1.0 * @since 4.1.0
* @since 4.7.0 Added support for author archives. * @since 4.7.0 Added support for author archives.
* @since 4.9.0 Added support for post type archives.
* *
* @see term_description() * @see term_description()
* *
* @return string Archive description. * @return string Archive description.
*/ */
function get_the_archive_description() { function get_the_archive_description() {
$description = '';
if ( is_author() ) { if ( is_author() ) {
$description = get_the_author_meta( 'description' ); $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 { } else {
$description = term_description(); $description = term_description();
} }

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.9-alpha-40975'; $wp_version = '4.9-alpha-40976';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.