wordpress开发语言

WordPress开发API接口:JWT(插件篇)

说明

使用WordPress开发API接口时,最重要的就是接口鉴权,也就是JWT。

WordPress默认的路由功能是不能鉴权的,也就是没办法验证你是否真的登录了,这时候就需要开发。

本系列教程就是教大家如何使用WordPress默认的路由方式开发JWT鉴权功能。

环境php >=7.3WordPress >=5.7JWT Authentication for WP-API 1.2.6JWT Authentication for WP-API

该插件是WordPress插件市场上的一款免费插件,它自带了JWT鉴权功能,可以更快速地开发WordPress JWT鉴权接口,很适合新手使用,因此本系列教程将为大家讲解该插件的使用和二次开发。

市面上很流行的WordPress主题 7b2轻社交主题(本站使用的主题)就是用这个插件开发的。

教程准备安装好WordPress安装好推荐的插件:JWT Authentication for WP-API一套可以二次开发的主题你会学到什么深度二次开发JWT Authentication for WP REST API 插件学会WordPress API(wp-api) 的路由鉴权

WordPress开发API接口:JWT(插件篇) – WordPress代码库

wordpress自定义rest API 接口的开发

虽然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接口就实现了,
接下来直接访问 ,便可以看到会输出 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'

] );

}

访问连接: ,这相当于在连接后面传递了一个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接口汇总

WordPress区块开发说明 WordPress 5.8 的 API 更新

扩展之前在 WordPress 5.6和5.7 中实现的块支持,WordPress 5.8 引入了几个新的块标志和新选项来自定义您注册的块。supports

新的支持

color._experimentalDuotone– 为您的区块添加双色调支持是一项新的实验性功能。要进行测试,请将此属性设置为指定要应用双色调的CSS选择器的字符串。例如,在您的块元数据中:

supports: { color: { _experimentalDuotone: '> .duotone-img' }}

color.link– 添加了对链接颜色的支持,这反映了color.textWP 5.6 中添加的使用和支持。

要在您的块中使用,请在块元数据中添加支持标志:

supports: { color: { link: true; }}

您可以使用属性定义默认值,theme.json如果存在,它还将使用设置的值。例如:

attributes: { style: { type: 'object', default: { color: { link: '#FF0000', } }稳定支撑API

WordPress 5.7 中的两个实验性功能已在 WordPress 5.8 中稳定下来

fontSize 之前 __experimentalFontSizelineHeight 之前 __experimentalLineHeight

有关使用详细信息,请参阅Block Supports API 文档。

间距支持已更新和扩展以适用于服务器端块,并添加细粒度支持以单独配置边 ( top, right, bottom, left) 的间距。例如:

supports: { spacing: { margin: true, // Enable margin UI control. padding: true, // Enable padding UI control. }}

以下示例仅配置了top和 的侧面支持bottom:

supports: { spacing: { margin: [ 'top', 'bottom' ], // Enable margin for arbitrary sides. padding: true, // Enable padding for all sides. }}

间距supports可以使用theme.json或它自己的属性来定位特定块。例如,定制top和bottom余量为core/separator块:

"styles": { "blocks": { "core/separator": { "spacing": { "margin": { "top": "100px", "bottom": "100px" } } } }}

道具@ mkaz和 @ nosolosw 与编译此帮助 开发笔记。