函数文档

rest_get_allowed_schema_keywords()

💡 云策文档标注

概述

rest_get_allowed_schema_keywords() 函数用于获取所有有效的 JSON schema 属性。它返回一个包含这些属性的字符串数组,适用于 WordPress REST API 开发中的 schema 定义。

关键要点

  • 函数返回一个字符串数组,列出所有有效的 JSON schema 属性,如 'title'、'description'、'type' 等。
  • 该函数在 WordPress 5.6.0 版本中引入,是 REST API 相关开发的基础工具。
  • 常用于配合其他函数如 rest_get_endpoint_args_for_schema() 和 WP_REST_Server::get_data_for_route() 来处理 schema 参数。

代码示例

function rest_get_allowed_schema_keywords() {
    return array(
        'title',
        'description',
        'default',
        'type',
        'format',
        'enum',
        'items',
        'properties',
        'additionalProperties',
        'patternProperties',
        'minProperties',
        'maxProperties',
        'minimum',
        'maximum',
        'exclusiveMinimum',
        'exclusiveMaximum',
        'multipleOf',
        'minLength',
        'maxLength',
        'pattern',
        'minItems',
        'maxItems',
        'uniqueItems',
        'anyOf',
        'oneOf',
    );
}

📄 原文内容

Get all valid JSON schema properties.

Return

string[] All valid JSON schema properties.

Source

function rest_get_allowed_schema_keywords() {
	return array(
		'title',
		'description',
		'default',
		'type',
		'format',
		'enum',
		'items',
		'properties',
		'additionalProperties',
		'patternProperties',
		'minProperties',
		'maxProperties',
		'minimum',
		'maximum',
		'exclusiveMinimum',
		'exclusiveMaximum',
		'multipleOf',
		'minLength',
		'maxLength',
		'pattern',
		'minItems',
		'maxItems',
		'uniqueItems',
		'anyOf',
		'oneOf',
	);
}

Changelog

Version Description
5.6.0 Introduced.