WordPress开发手册:post_type_archive_title()

函数原型

post_type_archive_title( string $prefix = ”, bool $display = true ): string|void

函数描述

是否弃用

未弃用

函数参数

$prefix
string
Optional

What to display before the title.

Default: ''

$display
bool
Optional

Whether to display or retrieve title.

Default: true

函数返回值

函数位置

函数源码

function post_type_archive_title( $prefix = '', $display = true ) {
	if ( ! is_post_type_archive() ) {
		return;
	}

	$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 );

	/**
	 * Filters the post type archive title.
	 *
	 * @since 3.1.0
	 *
	 * @param string $post_type_name Post type 'name' label.
	 * @param string $post_type      Post type.
	 */
	$title = apply_filters( 'post_type_archive_title', $post_type_obj->labels->name, $post_type );

	if ( $display ) {
		echo $prefix . $title;
	} else {
		return $prefix . $title;
	}
}

源码链接

WordPress
Github

变更日志