pinkcrab/wp-rest-schema

用于编写 WP Json Rest Schema 的库

维护者

详情

github.com/Pink-Crab/WP_Rest_Schema

主页

源代码

问题

安装次数: 7,258

依赖者: 2

建议者: 0

安全性: 0

星标: 1

关注者: 0

分支: 0

开放问题: 11

0.0.1-beta3 2021-11-24 23:47 UTC

Requires

  • php: >=7.1.0

Requires (Dev)

MIT 2038c49b68efef602a870a61f18bb6c3d7294c22

This package is auto-updated.

Last update: 2024-09-09 16:16:12 UTC

README

....

alt text Open Source Love codecov Scrutinizer Code Quality

版本 0.1.0-beta3

为什么？

在 WordPress 中定义有效的 JSON rest schema 有点混乱，也容易出错，因为有很多嵌套数组。这个库试图通过一个完全流畅、面向对象的接口使这个过程更干净、更简单。

设置

要安装，您可以使用 composer

$ composer require pinkcrab/wp-rest-schema

for_meta_data

基本用法

这可以用于注册文章元数据

register_post_meta( 'post', 'fixed_in', array(
    'type'         => 'string',
    'show_in_rest' => array(
        'single' => true,
        'schema' => Argument_Parser::for_meta_data(
            String_Type::on('fixed_in')
                ->min_length(10)
                ->max_length( 42 )
                ->required()
                ->description('This is a required string value, that must be between 10 and 42 chars long.')
        ),
    ),
) );

也可以与 Perique Registerable 库一起使用

    $meta_data = (new Meta_Data('fixed_in'))
        ->post_type('post')
        ->type('string')
        ->rest_schema(
            Argument_Parser::for_meta_data(
                String_Type::on( 'fixed_in' )
                    ->min_length(10)
                    ->max_length( 42 )
                    ->required()
                    ->description('This is a required string value, that must be between 10 and 42 chars long.')
            )
        );

WP Rest Schema Builder 可以用于各种您通常定义模式的地方，例如 Rest 路由、注册文章类型、分类和元数据。

变更日志

  • 0.1.0 初始版本