钩子文档

rest_request_parameter_order

💡 云策文档标注

概述

此过滤器用于调整 REST API 请求中参数优先级顺序,影响 WP_REST_Request::get_param() 等方法检查参数的顺序,类似于 PHP 的 request_order 设置。

关键要点

  • 过滤器名称:rest_request_parameter_order
  • 参数:$order(字符串数组,优先级顺序类型)和 $request(WP_REST_Request 对象)
  • 影响方法:WP_REST_Request::get_param() 及相关方法
  • 引入版本:WordPress 4.4.0

代码示例

return apply_filters( 'rest_request_parameter_order', $order, $this );

注意事项

  • 此过滤器与 PHP 的 request_order 设置功能类似,用于控制参数检查顺序。
  • 相关函数:WP_REST_Request::get_parameter_order() 用于检索参数优先级顺序。

📄 原文内容

Filters the parameter priority order for a REST API request.

Description

The order affects which parameters are checked when using WP_REST_Request::get_param() and family. This acts similarly to PHP’s request_order setting.

Parameters

$orderstring[]
Array of types to check, in order of priority.
$requestWP_REST_Request
The request object.

Source

return apply_filters( 'rest_request_parameter_order', $order, $this );

Changelog

Version Description
4.4.0 Introduced.