WordPress 修改 RESTful API 的请求和响应
像素鱼丸
11-22
196

有两种方法可用于将数据添加到 WordPress REST API 的响应:

  • register_rest_field 可用于向任何 RESTful API 响应添加任意字段,并可用于使用API读取和写入数据。要注册新的 RESTful API 字段,您必须提供自己的回调函数来获取或设置字段的值,并手动为字段指定自己的模式定义。
  • register_meta 用于将现有的自定义元值列入白名单,以便通过REST API进行访问。通过将元字段的show_in_rest参数设置为true,该字段的值将在端点响应中的.meta键上公开,WordPress 将处理设置回调以读取和写入该元键。这比register_rest_field 简单一些。

详细文档:https://developer.wordpress.org/rest-api/extending-the-rest-api/modifying-responses/

register_rest_field

add_action('rest_api_init', function () {
    // ‘post’ 文章类型,也可以是其他文章类型,‘my-my_post_meta’ 是前端提交过来的数据
    register_rest_field('post', 'my_post_meta', array(
        // 把自定义字段数据附加到 Rest API 文章接口返回的 Json 数据里
        'get_callback' => function ($object) {
            $my_post_meta = get_post_meta($object['id'], 'my_post_meta', true);
            return $my_post_meta;
        },
        // 保存数据的回调,获取前端提交过来的数据,然后保存
        'update_callback' => function ($value, $post_object) {
            $post_id = $post_object->ID;
            add_post_meta($post_Id, 'my_post_meta', $value, true) or
                    update_post_meta($post_id, 'my_post_meta', $value);
            return true;
        }
    ));
});

register_meta

register_meta(
  'post',
  'oss_url',
  array(
    'single' => true,
    'type' => 'string',
    'show_in_rest' => true
  )
);

请求数据的格式

###
POST https://dev.rangtuo.com/wp-json/wp/v2/audios/162
content-type: application/json; charset=utf-8
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2OTkwMzAyNDQsImV4cCI6MTY5OTA5MDI0NCwibmJmIjoxNjk5MDMwMjQ0LCJ1c2VyX2lkIjoiMSJ9.uesgf5_cYKGXOyGmEOghsj8TiTX2Kh-npJhdR2R0rbI

{
    "title":"一个测试用的5",
    "content":"这是内容",
    "my_post_meta":"这里是自定义字段的值"
}
收藏
打赏
WordPress RESTful API 路由代码结构
上一篇
WordPress WP_Query() 教程
下一篇

发表评论

注册不是必须的

像素鱼丸
157 文章
2 评论
4 喜欢
最新文章

付费资源下载时间限制有什么用?

这个功能确实挺常见的,它背后的逻辑其实不是“防君子”,而是“防小人”和“控成本”。有没有必要做,主要取决于你平台上的资源类型和你的运营阶段。 我们可以从三个角度来看看这个“10天有效期”到底有什么用: 增加倒卖和二次传播的成本(防黄牛) 这是最核心的意义。如果你的资源是虚拟商品(比如教程、源码、素材包),用户付一次钱理论上可以无限复制。 如果没有有效期: 一个人买了,转手挂到闲鱼或者别的群里卖,你 […]

退款和取消订单接口要不要合并

很多开发者在设计初期的常见思路。将“取消”和“退款”分开,从功能上看似乎很清晰,但在实际的复杂业务场景中,这种设计可能会带来一些问题。 更主流和推荐的设计是提供一个统一的“申请取消订单”接口,由后端服务根据订单的当前状态,自动路由到不同的处理逻辑。  为什么统一接口是更好的选择? 前端逻辑简化: 对于用户而言,他的诉求只有一个:“我不想要这个订单了”。无论订单是否支付,他在前端点击的都是“取消订单 […]

Mirage 主题 v3.7.0 发布

Mirage 主题 v3.7.0 发布 feat 增加拉黑用户功能 feat 移动端向下滑动时隐藏header,向上滑动时显示header 下载地址 https://gitee.com/vthemecn/mirage/releases/tag/v3.7.0 https://github.com/vthemecn/mirage/releases/tag/v3.7.0 新增功能截图
生成中...
扫描二维码
扫描二维码