类文档

WP_Block_Template

💡 云策文档标注

概述

WP_Block_Template 是 WordPress 中用于表示块模板的类,自 5.8.0 版本引入。它定义了块模板的核心属性,如类型、主题、内容来源等,支持主题和自定义模板的管理。

关键要点

  • WP_Block_Template 类代表块模板,用于处理 WordPress 的模板系统。
  • 主要属性包括 type(固定为 wp_template)、theme、slug、id、content、source(如 theme 或 custom)、origin、wp_id、status、has_theme_file、is_custom、author、plugin、post_types、area 和 modified。
  • 属性如 source 和 origin 用于区分模板内容的来源(如主题或自定义),is_custom 标识是否为自定义模板。
  • 自 5.8.0 版本引入,后续版本(如 5.9.0、6.3.0、6.7.0)添加了新属性以增强功能。

📄 原文内容

Class representing a block template.

Source

class WP_Block_Template {

	/**
	 * Type: wp_template.
	 *
	 * @since 5.8.0
	 * @var string
	 */
	public $type;

	/**
	 * Theme.
	 *
	 * @since 5.8.0
	 * @var string
	 */
	public $theme;

	/**
	 * Template slug.
	 *
	 * @since 5.8.0
	 * @var string
	 */
	public $slug;

	/**
	 * ID.
	 *
	 * @since 5.8.0
	 * @var string
	 */
	public $id;

	/**
	 * Title.
	 *
	 * @since 5.8.0
	 * @var string
	 */
	public $title = '';

	/**
	 * Content.
	 *
	 * @since 5.8.0
	 * @var string
	 */
	public $content = '';

	/**
	 * Description.
	 *
	 * @since 5.8.0
	 * @var string
	 */
	public $description = '';

	/**
	 * Source of the content. `theme` and `custom` is used for now.
	 *
	 * @since 5.8.0
	 * @var string
	 */
	public $source = 'theme';

	/**
	 * Origin of the content when the content has been customized.
	 * When customized, origin takes on the value of source and source becomes
	 * 'custom'.
	 *
	 * @since 5.9.0
	 * @var string|null
	 */
	public $origin;

	/**
	 * Post ID.
	 *
	 * @since 5.8.0
	 * @var int|null
	 */
	public $wp_id;

	/**
	 * Template Status.
	 *
	 * @since 5.8.0
	 * @var string
	 */
	public $status;

	/**
	 * Whether a template is, or is based upon, an existing template file.
	 *
	 * @since 5.8.0
	 * @var bool
	 */
	public $has_theme_file;

	/**
	 * Whether a template is a custom template.
	 *
	 * @since 5.9.0
	 *
	 * @var bool
	 */
	public $is_custom = true;

	/**
	 * Author.
	 *
	 * A value of 0 means no author.
	 *
	 * @since 5.9.0
	 * @var int|null
	 */
	public $author;

	/**
	 * Plugin.
	 *
	 * @since 6.7.0
	 * @var string|null
	 */
	public $plugin;

	/**
	 * Post types.
	 *
	 * @since 5.9.0
	 * @var string[]|null
	 */
	public $post_types;

	/**
	 * Area.
	 *
	 * @since 5.9.0
	 * @var string|null
	 */
	public $area;

	/**
	 * Modified.
	 *
	 * @since 6.3.0
	 * @var string|null
	 */
	public $modified;
}

Changelog

Version Description
5.8.0 Introduced.