函数文档

wp_create_initial_post_meta()

💡 云策文档标注

概述

wp_create_initial_post_meta() 函数用于注册额外的文章元数据字段,具体示例展示了为 'wp_block' 文章类型注册 'wp_pattern_sync_status' 元键。

关键要点

  • 函数核心功能是调用 register_post_meta() 来注册文章元数据
  • 示例中注册的元键 'wp_pattern_sync_status' 用于 'wp_block' 文章类型,类型为字符串,支持 REST API 并限制枚举值
  • 该函数在 WordPress 6.3.0 版本中引入

代码示例

register_post_meta(
    'wp_block',
    'wp_pattern_sync_status',
    array(
        'sanitize_callback' => 'sanitize_text_field',
        'single'            => true,
        'type'              => 'string',
        'show_in_rest'      => array(
            'schema' => array(
                'type' => 'string',
                'enum' => array( 'partial', 'unsynced' ),
            ),
        ),
    )
);

📄 原文内容

Registers any additional post meta fields.

Source

function wp_create_initial_post_meta() {
	register_post_meta(
		'wp_block',
		'wp_pattern_sync_status',
		array(
			'sanitize_callback' => 'sanitize_text_field',
			'single'            => true,
			'type'              => 'string',
			'show_in_rest'      => array(
				'schema' => array(
					'type' => 'string',
					'enum' => array( 'partial', 'unsynced' ),
				),
			),
		)
	);
}

Changelog

Version Description
6.3.0 Introduced.