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

Timestamp:

11/04/2014 12:35:00 AM (10 years ago)

Author:

johnbillion

Message:

Introduce some new template functions for archive titles and descriptions:

• get_the_archive_title() and the_archive_title() for returning/displaying the title of the current term, date, post type, post format, or author archive.
• get_the_archive_description() and the_archive_description() for returning/displaying the description associated with the current term archive.

Fixes #21995
Props obenland, DrewAPicture

File:

• trunk/src/wp-includes/general-template.php (modified) (1 diff)

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

@@ -1109 +1109 @@
         return $result;
     echo $result;
+}
+
+/**
+ * Display the archive title based on the queried object.
+ *
+ * @since 4.1.0
+ *
+ * @param string $before Optional. Content to prepend to the title.
+ * @param string $after  Optional. Content to append to the title.
+ */
+function the_archive_title( $before = '', $after = '' ) {
+    $title = get_the_archive_title();
+
+    if ( ! empty( $title ) ) {
+        echo $before . $title . $after;
+    }
+}
+
+/**
+ * Retrieve the archive title based on the queried object.
+ *
+ * @since 4.1.0
+ *
+ * @return string Archive title.
+ */
+function get_the_archive_title() {
+    if ( is_category() ) {
+        $title = sprintf( __( 'Category: %s' ), single_cat_title( '', false ) );
+    } elseif ( is_tag() ) {
+        $title = sprintf( __( 'Tag: %s' ), single_tag_title( '', false ) );
+    } elseif ( is_author() ) {
+        $title = sprintf( __( 'Author: %s' ), '<span class="vcard">' . get_the_author() . '</span>' );
+    } elseif ( is_year() ) {
+        $title = sprintf( __( 'Year: %s' ), get_the_date( _x( 'Y', 'yearly archives date format' ) ) );
+    } elseif ( is_month() ) {
+        $title = sprintf( __( 'Month: %s' ), get_the_date( _x( 'F Y', 'monthly archives date format' ) ) );
+    } elseif ( is_day() ) {
+        $title = sprintf( __( 'Day: %s' ), get_the_date( _x( 'F j, Y', 'daily archives date format' ) ) );
+    } elseif ( is_tax( 'post_format', 'post-format-aside' ) ) {
+        $title = _x( 'Asides', 'post format archive title' );
+    } elseif ( is_tax( 'post_format', 'post-format-gallery' ) ) {
+        $title = _x( 'Galleries', 'post format archive title' );
+    } elseif ( is_tax( 'post_format', 'post-format-image' ) ) {
+        $title = _x( 'Images', 'post format archive title' );
+    } elseif ( is_tax( 'post_format', 'post-format-video' ) ) {
+        $title = _x( 'Videos', 'post format archive title' );
+    } elseif ( is_tax( 'post_format', 'post-format-quote' ) ) {
+        $title = _x( 'Quotes', 'post format archive title' );
+    } elseif ( is_tax( 'post_format', 'post-format-link' ) ) {
+        $title = _x( 'Links', 'post format archive title' );
+    } elseif ( is_tax( 'post_format', 'post-format-status' ) ) {
+        $title = _x( 'Statuses', 'post format archive title' );
+    } elseif ( is_tax( 'post_format', 'post-format-audio' ) ) {
+        $title = _x( 'Audio', 'post format archive title' );
+    } elseif ( is_tax( 'post_format', 'post-format-chat' ) ) {
+        $title = _x( 'Chats', 'post format archive title' );
+    } elseif ( is_post_type_archive() ) {
+        $title = sprintf( __( 'Archives: %s' ), post_type_archive_title( '', false ) );
+    } elseif ( is_tax() ) {
+        $tax = get_taxonomy( get_queried_object()->taxonomy );
+        /* translators: 1: Taxonomy singular name, 2: Current taxonomy term */
+        $title = sprintf( __( '%1$s: %2$s' ), $tax->labels->singular_name, single_term_title( '', false ) );
+    } else {
+        $title = __( 'Archives' );
+    }
+
+    /**
+     * Filter the archive title.
+     *
+     * @since 4.1.0
+     *
+     * @param string $title Archive title to be displayed.
+     */
+    return apply_filters( 'get_the_archive_title', $title );
+}
+
+/**
+ * Display category, tag, or term description.
+ *
+ * @since 4.1.0
+ *
+ * @param string $before Optional. Content to prepend to the description.
+ * @param string $after  Optional. Content to append to the description.
+ */
+function the_archive_description( $before = '', $after = '' ) {
+    $description = get_the_archive_description();
+
+    if ( ! empty( $description ) ) {
+        echo $before . $description . $after;
+    }
+}
+
+/**
+ * Retrieve category, tag, or term description.
+ *
+ * @since 4.1.0
+ *
+ * @return string Archive description.
+ */
+function get_the_archive_description() {
+
+    /**
+     * Filter the archive description.
+     *
+     * @since 4.1.0
+     *
+     * @param string $description Archive description to be displayed.
+     */
+    return apply_filters( 'get_the_archive_description', term_description() );
 }