get_the_archive_title()

💡 云策文档标注

概述

get_the_archive_title() 函数用于根据当前查询对象检索并返回归档页面的标题。它通过一系列条件判断（如 is_category()、is_tag() 等）来确定标题和前缀，并支持通过过滤器进行自定义。

关键要点

函数返回字符串类型的归档标题，基于查询对象动态生成。
支持多种归档类型，包括分类、标签、作者、日期、自定义分类法和文章类型归档。
使用 get_the_archive_title_prefix 过滤器可修改标题前缀，get_the_archive_title 过滤器可修改整个标题。
从 WordPress 5.5 版本开始，标题部分被包裹在元素中。

代码示例

// 移除归档标题前缀的示例函数
function my_theme_archive_title( $title ) {
    if ( is_category() ) {
        $title = single_cat_title( '', false );
    } elseif ( is_tag() ) {
        $title = single_tag_title( '', false );
    } elseif ( is_author() ) {
        $title = '<span class="vcard">' . get_the_author() . '</span>';
    } elseif ( is_post_type_archive() ) {
        $title = post_type_archive_title( '', false );
    } elseif ( is_tax() ) {
        $title = single_term_title( '', false );
    }
    return $title;
}
add_filter( 'get_the_archive_title', 'my_theme_archive_title' );

注意事项

在 WordPress 5.5 及更高版本中，可以使用 add_filter( 'get_the_archive_title_prefix', '__return_false' ) 来移除前缀。
相关函数包括 the_archive_title() 用于显示标题，以及多个 is_*() 条件函数用于判断归档类型。

📄 原文内容

Retrieves the archive title based on the queried object.

Return

string Archive title.

Source

function get_the_archive_title() {
	$title  = __( 'Archives' );
	$prefix = '';

	if ( is_category() ) {
		$title  = single_cat_title( '', false );
		$prefix = _x( 'Category:', 'category archive title prefix' );
	} elseif ( is_tag() ) {
		$title  = single_tag_title( '', false );
		$prefix = _x( 'Tag:', 'tag archive title prefix' );
	} elseif ( is_author() ) {
		$title  = get_the_author();
		$prefix = _x( 'Author:', 'author archive title prefix' );
	} elseif ( is_year() ) {
		/* translators: See https://www.php.net/manual/datetime.format.php */
		$title  = get_the_date( _x( 'Y', 'yearly archives date format' ) );
		$prefix = _x( 'Year:', 'date archive title prefix' );
	} elseif ( is_month() ) {
		/* translators: See https://www.php.net/manual/datetime.format.php */
		$title  = get_the_date( _x( 'F Y', 'monthly archives date format' ) );
		$prefix = _x( 'Month:', 'date archive title prefix' );
	} elseif ( is_day() ) {
		/* translators: See https://www.php.net/manual/datetime.format.php */
		$title  = 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' );
		} 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  = 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 );
			$title  = 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 $original_title Archive title without prefix.
	 * @param string $prefix         Archive title prefix.
	 */
	return apply_filters( 'get_the_archive_title', $title, $original_title, $prefix );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘get_the_archive_title’, string $title, string $original_title, string $prefix ): Filters the archive title.
apply_filters( ‘get_the_archive_title_prefix’, string $prefix ): Filters the archive title prefix.

Uses	Description
get_the_date()`wp-includes/general-template.php`	Retrieves the date of the post.
single_cat_title()`wp-includes/general-template.php`	Displays or retrieves page title for category archive.
single_tag_title()`wp-includes/general-template.php`	Displays or retrieves page title for tag post archive.
post_type_archive_title()`wp-includes/general-template.php`	Displays or retrieves title for a post type archive.
single_term_title()`wp-includes/general-template.php`	Displays or retrieves page title for taxonomy term archive.
is_year()`wp-includes/query.php`	Determines whether the query is for an existing year archive.
is_category()`wp-includes/query.php`	Determines whether the query is for an existing category archive page.
is_tag()`wp-includes/query.php`	Determines whether the query is for an existing tag archive page.
is_author()`wp-includes/query.php`	Determines whether the query is for an existing author archive page.
is_month()`wp-includes/query.php`	Determines whether the query is for an existing month archive.
is_day()`wp-includes/query.php`	Determines whether the query is for an existing day archive.
is_tax()`wp-includes/query.php`	Determines whether the query is for an existing custom taxonomy archive page.
is_post_type_archive()`wp-includes/query.php`	Determines whether the query is for an existing post type archive page.
get_queried_object()`wp-includes/query.php`	Retrieves the currently queried object.
get_the_author()`wp-includes/author-template.php`	Retrieves the author of the current post.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
_x()`wp-includes/l10n.php`	Retrieves translated string with gettext context.
get_taxonomy()`wp-includes/taxonomy.php`	Retrieves the taxonomy object of $taxonomy.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 14 more Show less

Used by	Description
the_archive_title()`wp-includes/general-template.php`	Displays the archive title based on the queried object.

Changelog

Version	Description
5.5.0	The title part is wrapped in a `<span>` element.
4.1.0	Introduced.

User Contributed Notes

Skip to note 5 content

WebMan Design | Oliver Juhas

10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 35You must log in to vote on the helpfulness of this note
TIP: Getting rid of archive “label”

If you would like to get rid of the “Category:”, “Tag:”, “Author:”, “Archives:” and “Other taxonomy name:” in the archive title, use this little function in your (child) theme functions.php file:
```
function my_theme_archive_title( $title ) {
	if ( is_category() ) {
		$title = single_cat_title( '', false );
	} elseif ( is_tag() ) {
		$title = single_tag_title( '', false );
	} elseif ( is_author() ) {
		$title = '<span class="vcard">' . get_the_author() . '</span>';
	} elseif ( is_post_type_archive() ) {
		$title = post_type_archive_title( '', false );
	} elseif ( is_tax() ) {
		$title = single_term_title( '', false );
	}
 
	return $title;
}

add_filter( 'get_the_archive_title', 'my_theme_archive_title' );
```
- Just an update on this: I’ve actually created a plugin Archive Title that takes care of this. You can find it at WordPress plugins repository at https://wordpress.org/plugins/archive-title/
  
  WebMan Design | Oliver Juhas 7 years ago
- The get_the_archive_title_prefix filter was introduced in 5.5.
  
  Priscilla Chapman 4 years ago
- This would be the correct method post v5.5: add_filter( 'get_the_archive_title_prefix', '__return_false' );
  
  studiolxv 2 years ago
Log in to add feedback
Skip to note 6 content

Muhammad Ismail

9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 18You must log in to vote on the helpfulness of this note
CPT Title Without word: ‘Archive’:
If you are building custom archive template for a CPT, and want to output just the title of the CPT with no extra word like “Archive” use following function instead:
```
echo post_type_archive_title( '', false );
```
- Just put the following code in your functions.php to remove “Archive:” prefix. add_filter( 'get_the_archive_title_prefix', '__return_empty_string' );
  
  seeker5084 3 years ago
Log in to add feedback
Skip to note 7 content

WP SITES

9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
Add text or execute a function before the archive title.
```
add_filter( 'get_the_archive_title', 'modify_archive_title', 10, 1 );

function modify_archive_title( $title ) {
        
    $var = "1";

    return $var . $title;

}
```
Log in to add feedback
Skip to note 8 content

2046

5 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
or simply
```
$q = get_queried_object();
// category title : custom post type archive title
$title = is_category() ? $q->name : $q->labels->name;
```
Log in to add feedback

云策 WordPress 开发者社区

函数文档

get_the_archive_title()

概述

关键要点

代码示例

注意事项

Return

Source

Hooks

Changelog

User Contributed Notes

函数文档

概述

关键要点

代码示例

注意事项

Return

Source

Hooks

Related

Changelog

User Contributed Notes