wordpress自定义rest API 接口的开发-xx主题网

虽然wordpress提供了很多常用的接口，但是往往我们在开发时自定义接口才是我们需要的，我们需要对接口进行再次加工，开发新的接口，
wordpress很人性的对我们提供了两个函数以实现这方面的需求。

1、rest_api_init 钩子函数，注册接口的相关信息需要挂载到此钩子上
2、register_rest_route 接口路由函数

一个例子

先看一个例子，方便我们更好的理解，这两个函数。

function xxzhuti_rest_hello_callback()
{
return 'hello xxzhuti.com';
}

function xxzhuti_rest_register_route()
{
register_rest_route( 'xxzhuti/v1', 'hello', [
'methods' => 'GET',
'callback' => 'xxzhuti_rest_hello_callback'
] );
}

add_action( 'rest_api_init', 'xxzhuti_rest_register_route');

自定义一个函数 xxzhuti_rest_register_route 将此函数挂载到rest_api_init钩子上，在此函数中用resgister_rest_route注册接口地址需要访问的路由,
自定义访问的方式，并且定义好回调函数 xxzhuti_rest_hello_callback ，在回调函数中写你需要实现的各种功能，这样一个基本的自定义rest api接口就实现啦，
接下来直接访问 https://www.xxzhuti.com/wp-json/xxzhuti/v1/hello，便可以看到会输出 hello xxzhuti.com啦。

请求参数

在回调函数中，添加一个 $request 的参数，它的里面会包含从客户端发送过来的信息。

function xxzhuti_rest_hello_callback($request)
{
$id = $request['id'];
return 'hello xxzhuti.com'.$id;
}

我们可以改造一下上面的路由，添加一些参数

function xxzhuti_rest_register_route()
{
register_rest_route( 'xxzhuti/v1', 'hello/(?P<id>[\d]+)', [
'methods' => 'GET',
'callback' => 'xxzhuti_rest_hello_callback'
] );
}

访问连接：https://www.xxzhuti.com/wp-json/xxzhuti/v1/hello/1 ，这相当于在连接后面传递了一个id的参数，(?P<id>[\d]+) 正则规定了必须是整数。

获取参数

$request['some_param']; //指定参数数组
$request->get_param( 'some_param' ); //指定参数
$request->get_params(); //全部参数数组
$request->get_url_params();
$request->get_query_params();
$request->get_body_params();
$request->get_json_params();
$request->get_default_params();
$request->get_file_params(); 文件参数

数据验证

function xxzhuti_rest_register_route()
{
register_rest_route( 'xxzhuti/v1', 'hello/(?P<id>[\d]+)', [
'methods' => 'GET',
'callback' => 'xxzhuti_rest_hello_callback',
'args' => [
'validate_callback' => 'xxzhuti_rest_validate_id', //验证数据的函数
'sanitize_callback' => 'xxzhuti_rest_check_id' //数据在入库之前进行处理
]
] );
}

function xxzhuti_rest_validate_id($param, $request, $key)
{
if(is_numeric($param)) return true;
}

权限

在写接口的时候，可以检查用户的权限，规定一些接口需要具备何种权限才可以访问

function xxzhuti_rest_register_route()
{
register_rest_route( 'xxzhuti/v1', 'hello/(?P<id>[\d]+)', [
'methods' => 'GET',
'callback' => 'xxzhuti_rest_hello_callback',
'args' => [
'validate_callback' => 'xxzhuti_rest_validate_id', //验证数据的函数
'sanitize_callback' => 'xxzhuti_rest_check_id' //数据在入库之前进行处理
],
'permission_callback' => 'xxzhuti_rest_permission_check' //权限检查
] );
}

function xxzhuti_rest_permission_check()
{
return current_user_can('edit_other_posts');
}

错误信息

使用 WP_Error 返回错误信息

function xxzhuti_rest_hello_callback($request)
{
$id = $request['id'];
if(!$id)
{
return new WP_Error( 'can_not_ID', 'Invalid ID', array( 'status' => 404 ) );
}
return 'hello xxzhuti.com'.$id;
}

入门的WP REST API 可以查看上一篇文章，看懂这两篇文章，基本可以根据自己的博客做出各种接口。

WordPress 常用的 REST API接口汇总