rest_namespace_index
云策文档标注
概述
rest_namespace_index 是一个 WordPress REST API 过滤器,用于修改命名空间索引数据。它允许开发者在返回命名空间路由信息时添加自定义数据。
关键要点
- 过滤器名称:rest_namespace_index
- 作用:过滤 REST API 命名空间索引数据,通常包括路由数据,但可添加任意自定义数据
- 参数:$response(WP_REST_Response 对象,响应数据)和 $request(WP_REST_Request 对象,请求数据,其中命名空间通过 'namespace' 参数传递)
- 相关函数:WP_REST_Server::get_namespace_index() 用于检索命名空间索引
- 引入版本:WordPress 4.4.0
原文内容
Filters the REST API namespace index data.
Description
This typically is just the route data for the namespace, but you can add any data you’d like here.
Parameters
$responseWP_REST_Response-
Response data.
$requestWP_REST_Request-
Request data. The namespace is passed as the
'namespace'parameter.
Source
return apply_filters( 'rest_namespace_index', $response, $request );
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Introduced. |