Themes: Introduce get_the_archive_title_prefix filter for changing the prefix used for archive titles.

In `get_the_archive_title()` split the internal `$title` variable into `$title` and `$prefix`. By using the new `get_the_archive_title_prefix` filter the prefix can now wrapped with custom elements or removed completely by using

{{{
add_filter( 'get_the_archive_title_prefix', '__return_empty_string' );
}}}

Also, wrap the title part with a `span` element and pass the original title and prefix to the existing `get_the_archive_title` filter, allowing further customization to the archive titles.

Props Kaira, milindmore22, shireling, grapplerulrich, audrasjb, desrosj, Confridin, ramiy, ocean90.
Fixes #31237.
Fixes #38545.
Built from https://develop.svn.wordpress.org/trunk@48294


git-svn-id: http://core.svn.wordpress.org/trunk@48063 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-includes/general-template.php

@@ -1604,26 +1604,27 @@ function the_archive_title( $before = '', $after = '' ) {
  * @return string Archive title.
  */
 function get_the_archive_title() {
-	$title = __( 'Archives' );
+	$title  = __( 'Archives' );
+	$prefix = '';
 
 	if ( is_category() ) {
-		/* translators: Category archive title. %s: Category name. */
+		$title  = single_cat_title( '', false );
-		$title = sprintf( __( 'Category: %s' ), single_cat_title( '', false ) );
+		$prefix = _x( 'Category:', 'category archive title prefix' );
 	} elseif ( is_tag() ) {
-		/* translators: Tag archive title. %s: Tag name. */
+		$title  = single_tag_title( '', false );
-		$title = sprintf( __( 'Tag: %s' ), single_tag_title( '', false ) );
+		$prefix = _x( 'Tag:', 'tag archive title prefix' );
 	} elseif ( is_author() ) {
-		/* translators: Author archive title. %s: Author name. */
+		$title  = get_the_author();
-		$title = sprintf( __( 'Author: %s' ), '<span class="vcard">' . get_the_author() . '</span>' );
+		$prefix = _x( 'Author:', 'author archive title prefix' );
 	} elseif ( is_year() ) {
-		/* translators: Yearly archive title. %s: Year. */
+		$title  = get_the_date( _x( 'Y', 'yearly archives date format' ) );
-		$title = sprintf( __( 'Year: %s' ), get_the_date( _x( 'Y', 'yearly archives date format' ) ) );
+		$prefix = _x( 'Year:', 'date archive title prefix' );
 	} elseif ( is_month() ) {
-		/* translators: Monthly archive title. %s: Month name and year. */
+		$title  = get_the_date( _x( 'F Y', 'monthly archives date format' ) );
-		$title = sprintf( __( 'Month: %s' ), get_the_date( _x( 'F Y', 'monthly archives date format' ) ) );
+		$prefix = _x( 'Month:', 'date archive title prefix' );
 	} elseif ( is_day() ) {
-		/* translators: Daily archive title. %s: Date. */
+		$title  = get_the_date( _x( 'F j, Y', 'daily archives date format' ) );
-		$title = sprintf( __( 'Day: %s' ), get_the_date( _x( 'F j, Y', 'daily archives date format' ) ) );
+		$prefix = _x( 'Day:', 'date archive title prefix' );
 	} elseif ( is_tax( 'post_format' ) ) {
 		if ( is_tax( 'post_format', 'post-format-aside' ) ) {
 			$title = _x( 'Asides', 'post format archive title' );
@@ -1645,25 +1646,51 @@ function get_the_archive_title() {
 			$title = _x( 'Chats', 'post format archive title' );
 		}
 	} elseif ( is_post_type_archive() ) {
-		/* translators: Post type archive title. %s: Post type name. */
+		$title  = post_type_archive_title( '', false );
-		$title = sprintf( __( 'Archives: %s' ), post_type_archive_title( '', false ) );
+		$prefix = _x( 'Archives:', 'post type archive title prefix' );
 	} elseif ( is_tax() ) {
 		$queried_object = get_queried_object();
 		if ( $queried_object ) {
-			$tax = get_taxonomy( $queried_object->taxonomy );
+			$tax    = get_taxonomy( $queried_object->taxonomy );
-			/* translators: Taxonomy term archive title. 1: Taxonomy singular name, 2: Current taxonomy term. */
+			$title  = single_term_title( '', false );
-			$title = sprintf( __( '%1$s: %2$s' ), $tax->labels->singular_name, single_term_title( '', false ) );
+			$prefix = sprintf(
+				/* translators: %s: Taxonomy singular name. */
+				_x( '%s:', 'taxonomy term archive title prefix' ),
+				$tax->labels->singular_name
+			);
 		}
 	}
 
+	$original_title = $title;
+
+	/**
+	 * Filters the archive title prefix.
+	 *
+	 * @since 5.5.0
+	 *
+	 * @param string $prefix Archive title prefix.
+	 */
+	$prefix = apply_filters( 'get_the_archive_title_prefix', $prefix );
+	if ( $prefix ) {
+		$title = sprintf(
+			/* translators: 1: Title prefix. 2: Title. */
+			_x( '%1$s %2$s', 'archive title' ),
+			$prefix,
+			'<span>' . $title . '</span>'
+		);
+	}
+
 	/**
 	 * Filters the archive title.
 	 *
 	 * @since 4.1.0
+	 * @since 5.5.0 Added the `$prefix` and `$original_title` parameters.
 	 *
-	 * @param string $title Archive title to be displayed.
+	 * @param string $title          Archive title to be displayed.
+	 * @param string $original_title Archive title without prefix.
+	 * @param string $prefix         Archive title prefix.
 	 */
-	return apply_filters( 'get_the_archive_title', $title );
+	return apply_filters( 'get_the_archive_title', $title, $original_title, $prefix );
 }
 
 /**

wp-includes/version.php

@@ -13,7 +13,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '5.5-alpha-48293';
+$wp_version = '5.5-alpha-48294';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.