在WordPress插件开发中,使用WP REST API来创建自定义API端点是一个相对直接的过程。以下是创建自定义API端点的基本步骤:
步骤 1: 创建插件文件
首先,你需要创建一个新的插件文件。假设你想要创建一个名为 my-custom-plugin
的插件,你可以创建以下文件:
wp-content/plugins/my-custom-plugin/my-custom-plugin.php
步骤 2: 设置插件基础信息
在 my-custom-plugin.php
文件中,你需要添加一些基础信息:
<?php
/*
Plugin Name: My Custom Plugin
Description: A plugin to create a custom REST API endpoint.
Version: 1.0
Author: Your Name
Author URI: http://yourwebsite.com/
*/
if (!defined('ABSPATH')) {
exit; // Exit if accessed directly
}
步骤 3: 注册自定义API端点
接下来,你需要使用 register_rest_route
函数来注册一个新的API端点。以下是一个例子,展示了如何创建一个名为 /my-plugin/v1/my-endpoint
的端点:
add_action('rest_api_init', function () {
register_rest_route('my-plugin/v1', '/my-endpoint', array(
'methods' => 'GET',
'callback' => 'my_custom_endpoint_callback',
));
});
步骤 4: 创建回调函数
你需要定义一个回调函数来处理API请求。这个函数将返回你想要的数据:
function my_custom_endpoint_callback($request) {
// 获取请求参数
$param = $request->get_param('my_param');
// 处理数据
$data = array(
'message' => 'Hello, World!',
'param' => $param,
);
// 返回响应
return new WP_REST_Response($data, 200);
}
在这个例子中,my_custom_endpoint_callback
函数将返回一个简单的消息和一个可能的请求参数。你可以根据需要添加更多的逻辑和数据处理。
步骤 5: 激活插件
将 my-custom-plugin.php
文件保存到 wp-content/plugins/my-custom-plugin/
目录中,并登录到WordPress仪表盘,在插件页面激活 My Custom Plugin
插件。
步骤 6: 测试API端点
现在,你的自定义API端点应该已经可用。你可以通过以下URL来测试它:
http://yourwordpresssite.com/wp-json/my-plugin/v1/my-endpoint
如果你添加了查询参数,例如 ?my_param=value
,这个参数将在回调函数中通过 $request->get_param('my_param')
被捕获。
确保在开发过程中遵守WordPress的安全最佳实践,并对用户输入进行适当的验证和清理。