1. 首页
  2. WordPress 函数手册
  3. rest

register_rest_route()

register_rest_route( string $namespace, string $route, array $args = array(), bool $override = false )

注册REST API路由。
Registers a REST API route.

目录锚点:#说明#参数#返回#源码#笔记


说明(Description)

注意:不要在“rest-api-init”钩子之前使用。


参数(Parameters)

参数 类型 必填 说明
$namespace (string) 必需 核心前缀后的第一个URL段。应该是你的包/插件所独有的。
$route (string) 必需 要添加的路由的基本URL。
$args (array) 可选 要么是端点的选项数组,要么是多个方法的数组。
$override (bool) 可选 如果路由已经存在,我们应该覆盖它吗?True重写,false合并(如果存在重复键,则使用较新的重写)。

返回(Return)

(bool)成功时为真,错误时为假。


源码(Source)


更新版本 源码位置 使用 被使用
5.1.0 wp-includes/rest-api.php:33 15 4

笔记(Notes)

确保regex表达式正常。如果数据不匹配,那么URL将返回404。
Args是一个命名数组,通常包含键“methods”和“callback”。
上面引用的命名数组Args也可以包含自己的可选“Args”数组。

register_rest_route() 为WP2原创文章,链接:https://www.wp2.cn/functions/register_rest_route/

发表评论

您的电子邮箱地址不会被公开。