函数文档

get_default_block_template_types()

💡 云策文档标注

概述

get_default_block_template_types() 函数返回一个经过过滤的默认模板类型列表,包含本地化的标题和描述。该函数主要用于 WordPress 块主题开发,为开发者提供标准模板类型的定义。

关键要点

  • 函数返回一个数组,每个元素代表一个模板类型,包含 'title' 和 'description' 键。
  • 默认模板类型包括 index、home、front-page、singular、single、page、archive、author、category、taxonomy、date、tag、attachment、search、privacy-policy 和 404。
  • 函数会自动添加文章格式模板类型,基于 get_post_format_strings() 返回的格式。
  • 可通过 'default_template_types' 过滤器钩子修改返回的模板类型列表。

代码示例

$default_template_types = array(
    'index' => array(
        'title' => _x( 'Index', 'Template name' ),
        'description' => __( 'Used as a fallback template for all pages when a more specific template is not defined.' ),
    ),
    // 其他模板类型定义...
);

注意事项

  • 函数自 WordPress 5.9.0 版本引入,适用于块主题和全站编辑功能。
  • 返回的标题和描述已本地化,使用 _x() 和 __() 函数进行翻译。
  • 开发者可以利用 apply_filters('default_template_types', $default_template_types) 钩子自定义模板类型列表。

📄 原文内容

Returns a filtered list of default template types, containing their localized titles and descriptions.

Return

array[] The default template types.
  • ...$0 array
    Data for the template type.
    • title string
      Template type title.
    • description string
      Template type description.

Source

function get_default_block_template_types() {
	$default_template_types = array(
		'index'          => array(
			'title'       => _x( 'Index', 'Template name' ),
			'description' => __( 'Used as a fallback template for all pages when a more specific template is not defined.' ),
		),
		'home'           => array(
			'title'       => _x( 'Blog Home', 'Template name' ),
			'description' => __( 'Displays the latest posts as either the site homepage or as the "Posts page" as defined under reading settings. If it exists, the Front Page template overrides this template when posts are shown on the homepage.' ),
		),
		'front-page'     => array(
			'title'       => _x( 'Front Page', 'Template name' ),
			'description' => __( 'Displays your site's homepage, whether it is set to display latest posts or a static page. The Front Page template takes precedence over all templates.' ),
		),
		'singular'       => array(
			'title'       => _x( 'Single Entries', 'Template name' ),
			'description' => __( 'Displays any single entry, such as a post or a page. This template will serve as a fallback when a more specific template (e.g. Single Post, Page, or Attachment) cannot be found.' ),
		),
		'single'         => array(
			'title'       => _x( 'Single Posts', 'Template name' ),
			'description' => __( 'Displays a single post on your website unless a custom template has been applied to that post or a dedicated template exists.' ),
		),
		'page'           => array(
			'title'       => _x( 'Pages', 'Template name' ),
			'description' => __( 'Displays a static page unless a custom template has been applied to that page or a dedicated template exists.' ),
		),
		'archive'        => array(
			'title'       => _x( 'All Archives', 'Template name' ),
			'description' => __( 'Displays any archive, including posts by a single author, category, tag, taxonomy, custom post type, and date. This template will serve as a fallback when more specific templates (e.g. Category or Tag) cannot be found.' ),
		),
		'author'         => array(
			'title'       => _x( 'Author Archives', 'Template name' ),
			'description' => __( 'Displays a single author's post archive. This template will serve as a fallback when a more specific template (e.g. Author: Admin) cannot be found.' ),
		),
		'category'       => array(
			'title'       => _x( 'Category Archives', 'Template name' ),
			'description' => __( 'Displays a post category archive. This template will serve as a fallback when a more specific template (e.g. Category: Recipes) cannot be found.' ),
		),
		'taxonomy'       => array(
			'title'       => _x( 'Taxonomy', 'Template name' ),
			'description' => __( 'Displays a custom taxonomy archive. Like categories and tags, taxonomies have terms which you use to classify things. For example: a taxonomy named "Art" can have multiple terms, such as "Modern" and "18th Century." This template will serve as a fallback when a more specific template (e.g. Taxonomy: Art) cannot be found.' ),
		),
		'date'           => array(
			'title'       => _x( 'Date Archives', 'Template name' ),
			'description' => __( 'Displays a post archive when a specific date is visited (e.g., example.com/2023/).' ),
		),
		'tag'            => array(
			'title'       => _x( 'Tag Archives', 'Template name' ),
			'description' => __( 'Displays a post tag archive. This template will serve as a fallback when a more specific template (e.g. Tag: Pizza) cannot be found.' ),
		),
		'attachment'     => array(
			'title'       => __( 'Attachment Pages' ),
			'description' => __( 'Displays when a visitor views the dedicated page that exists for any media attachment.' ),
		),
		'search'         => array(
			'title'       => _x( 'Search Results', 'Template name' ),
			'description' => __( 'Displays when a visitor performs a search on your website.' ),
		),
		'privacy-policy' => array(
			'title'       => __( 'Privacy Policy' ),
			'description' => __( 'Displays your site's Privacy Policy page.' ),
		),
		'404'            => array(
			'title'       => _x( 'Page: 404', 'Template name' ),
			'description' => __( 'Displays when a visitor views a non-existent page, such as a dead link or a mistyped URL.' ),
		),
	);

	// Add a title and description to post format templates.
	$post_formats = get_post_format_strings();
	foreach ( $post_formats as $post_format_slug => $post_format_name ) {
		$default_template_types[ 'taxonomy-post_format-post-format-' . $post_format_slug ] = array(
			'title'       => sprintf(
				/* translators: %s: Post format name. */
				_x( 'Post Format: %s', 'Template name' ),
				$post_format_name
			),
			'description' => sprintf(
				/* translators: %s: Post format name. */
				__( 'Displays the %s post format archive.' ),
				$post_format_name
			),
		);
	}

	/**
	 * Filters the list of default template types.
	 *
	 * @since 5.9.0
	 *
	 * @param array[] $default_template_types {
	 *     The default template types.
	 *
	 *     @type array ...$0 {
	 *         Data for the template type.
	 *
	 *         @type string $title       Template type title.
	 *         @type string $description Template type description.
	 *    }
	 * }
	 */
	return apply_filters( 'default_template_types', $default_template_types );
}

Hooks

apply_filters( ‘default_template_types’, array[] $default_template_types )

Filters the list of default template types.

Changelog

VersionDescription
5.9.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.