WordPress RESTful API 路由代码结构
像素鱼丸
11-22
151
0

WordPress 可以自由组织代码结构,这篇文章介绍我项目中路由相关的代码结构。

一,添加路由

相关函数

1、rest_api_init 钩子函数,注册接口的相关信息需要挂载到此钩子上。

2、register_rest_route 接口路由函数

add_action( 'rest_api_init', 'first_route_hook' );

function first_route_hook() {
  register_rest_route( 'rangtuo/v1', 'test/(?P<id>[\d]+)', [
    'methods'  => 'GET',
    'callback' => 'first_action_callback'
  ] );
}

function first_action_callback($request) {
  $params = $request->get_params();
  $id = $params['id'];

  return $id;
}

通过 http://www.test.com/wp-json/rangtuo/v1/test/666 访问接口。

$request 参数

$request->get_url_params();
$request->get_query_params();
$request->get_body_params();
$request->get_json_params();
$request->get_default_params();
$request->get_file_params(); // 上传的文件

检查权限

在使用接口的时候,可以检查用户的权限。

register_rest_route( 'rangtuo/v1', 'test/(?P<id>[\d]+)', [
  'methods' => 'GET',
  'callback' => 'rangtuo_cb',
  'permission_callback' => 'rangtuo_permission_callback'
]);

function rangtuo_permission_callback() {
  return current_user_can( 'edit_others_posts' );
}

代码示例:

add_action( 'rest_api_init', function () {
    register_rest_route( 'rangtuo/v1', '/author/(?P<id>\d+)', array(
        'methods' => 'GET',
        'callback' => 'test_callback',
    ));
});

function test_callback($request){
    $request->get_url_params();
    $request->get_query_params();
    $request->get_body_params();
    $request->get_json_params();
    $request->get_default_params();
    $request->get_file_params(); // 上传的文件
    
    $data = array(
        "message" => "hello",
        "test" => __('dada', 'rangtuo'),
        "dodo" => __('dodo', 'rangtuo')
    );
    $response = new WP_REST_Response($data);
    $response->set_status(403);
    return $response;
}

 

二,RESTful API 推荐的目录结构

项目中,接口模块目录结构:

├── api                               # 接口目录
|    ├── orders                       # 订单模块
|    |    ├── orders.controller.php   # 订单控制器
|    |    ├── orders.service.php      # 订单服务
|    |    └── routes.php              # 路由文件
|    └── stars                        # 收藏点赞模块
|    ├── auth                         # 注册登录模块
|    ├── ...                          # 其他模块

三,RESTful API 推荐的路由对应方法

 

收藏
打赏
WordPress 引入自定义 JavaScript 文件
上一篇
WordPress 修改 RESTful API 的请求和响应
下一篇

发表评论

注册不是必须的

像素鱼丸
150 文章
0 评论
4 喜欢
最新文章

宝塔 Nginx 拦截了 WordPress 返回 404 的状态

REST api 接口中,有段代码返回404,但是没有正常返回错误json: $wp_response = new \WP_REST_Response(array('error'=>'没有找到数据')); $wp_response->set_status(404); return $wp_response; 返回内容是: <html> <head><tit […]

Mirage 主题 v2.93.0 发布

更新内容: refactor 移除图片高宽比开关 refactor 移除全局的TOC生成开关 refactor 优化 header.php 中的seo模块和样式覆盖 feat 主题启用的时候,移除非当前主题注册的小工具 fix 修复分类小工具的bug feat 管理员打开后台,检查最当前设置首页布局的模块,如果缺少最新模块,就添加到隐藏模块列表中 fix 优化链接卡片样式 fix 优化热门文章样式 […]

如何使用 WordPress Setting API

使用 WordPress 的 Setting API 是在插件或主题中创建和管理设置页面的标准方式。它提供了一种结构化、安全的方式来保存和获取用户配置的选项。 ✅ 一、Setting API 简介 WordPress 的 Setting API 允许你: 创建设置页面(Settings Page) 注册设置字段(Settings Field) 验证和保存设置数据 使用表单提交来更新设置 ✅ 二、基 […]

详解 WordPress 的评论设置

好的,我们来详细梳理并总结 WordPress 中关于文章评论的两个核心控制层级:全局设置和单篇设置。理解这两者的关系(优先级)是管理网站评论的关键。 1. 全局设置 (Global Settings) —— 网站的“默认规则” 这是整个网站评论系统的总开关和默认行为准则。它决定了新发布的文章默认是什么样子的。 位置:WordPress 后台仪表盘 -> 设置 (Settings) -> […]
生成中...
扫描二维码
扫描二维码
用户登录