WP_Block_Parser_Frame
云策文档标注
概述
WP_Block_Parser_Frame 是一个用于在解析过程中临时存储部分块的类，属于 WordPress 块解析器的一部分。它通过构造函数初始化对象属性，包括块对象和字节偏移信息。
关键要点
- WP_Block_Parser_Frame 类用于在解析时保存部分块，支持块解析器的堆栈重建。
- 类包含公共属性如 $block（块对象）、$token_start（令牌起始字节偏移）、$token_length（令牌长度）、$prev_offset（令牌结束后的字节偏移）和 $leading_html_start（前导 HTML 起始字节偏移）。
- 构造函数 __construct 接受参数来设置这些属性，其中 $prev_offset 和 $leading_html_start 为可选参数，默认值基于其他参数计算。
代码示例
public function __construct( $block, $token_start, $token_length, $prev_offset = null, $leading_html_start = null ) {
$this->block = $block;
$this->token_start = $token_start;
$this->token_length = $token_length;
$this->prev_offset = isset( $prev_offset ) ? $prev_offset : $token_start + $token_length;
$this->leading_html_start = $leading_html_start;
}
原文内容
Class WP_Block_Parser_Frame
Description
Holds partial blocks in memory while parsing
Methods
| Name | Description |
|---|---|
| WP_Block_Parser_Frame::__construct | Constructor |
Source
class WP_Block_Parser_Frame {
/**
* Full or partial block
*
* @since 5.0.0
* @var WP_Block_Parser_Block
*/
public $block;
/**
* Byte offset into document for start of parse token
*
* @since 5.0.0
* @var int
*/
public $token_start;
/**
* Byte length of entire parse token string
*
* @since 5.0.0
* @var int
*/
public $token_length;
/**
* Byte offset into document for after parse token ends
* (used during reconstruction of stack into parse production)
*
* @since 5.0.0
* @var int
*/
public $prev_offset;
/**
* Byte offset into document where leading HTML before token starts
*
* @since 5.0.0
* @var int
*/
public $leading_html_start;
/**
* Constructor
*
* Will populate object properties from the provided arguments.
*
* @since 5.0.0
*
* @param WP_Block_Parser_Block $block Full or partial block.
* @param int $token_start Byte offset into document for start of parse token.
* @param int $token_length Byte length of entire parse token string.
* @param int|null $prev_offset Optional. Byte offset into document for after parse token ends. Default null.
* @param int|null $leading_html_start Optional. Byte offset into document where leading HTML before token starts.
* Default null.
*/
public function __construct( $block, $token_start, $token_length, $prev_offset = null, $leading_html_start = null ) {
$this->block = $block;
$this->token_start = $token_start;
$this->token_length = $token_length;
$this->prev_offset = isset( $prev_offset ) ? $prev_offset : $token_start + $token_length;
$this->leading_html_start = $leading_html_start;
}
}
Changelog
| Version | Description |
|---|---|
| 5.0.0 | Introduced. |