函数文档

rest_send_allow_header()

💡 云策文档标注

概述

rest_send_allow_header() 是一个 WordPress REST API 函数,用于发送“Allow”HTTP 头部,以声明当前路由支持的所有 HTTP 方法。它基于路由的权限回调函数动态确定允许的方法。

关键要点

  • 函数接收三个参数:$response(当前响应对象)、$server(WP_REST_Server 实例)和 $request(当前请求对象)。
  • 通过匹配路由和处理权限回调,计算允许的 HTTP 方法,并将结果以逗号分隔的字符串形式添加到响应头部。
  • 如果路由没有匹配或没有允许的方法,则直接返回原始响应而不添加头部。

代码示例

function rest_send_allow_header( $response, $server, $request ) {
    $matched_route = $response->get_matched_route();

    if ( ! $matched_route ) {
        return $response;
    }

    $routes = $server->get_routes();
    $allowed_methods = array();

    foreach ( $routes[ $matched_route ] as $_handler ) {
        foreach ( $_handler['methods'] as $handler_method => $value ) {
            if ( ! empty( $_handler['permission_callback'] ) ) {
                $permission = call_user_func( $_handler['permission_callback'], $request );
                $allowed_methods[ $handler_method ] = true === $permission;
            } else {
                $allowed_methods[ $handler_method ] = true;
            }
        }
    }

    $allowed_methods = array_filter( $allowed_methods );
    if ( $allowed_methods ) {
        $response->header( 'Allow', implode( ', ', array_map( 'strtoupper', array_keys( $allowed_methods ) ) ) );
    }

    return $response;
}

注意事项

  • 此函数在 WordPress 4.4.0 版本中引入,主要用于内部 REST API 处理,开发者通常不需要直接调用。
  • 权限回调函数(permission_callback)的结果直接影响允许方法的计算,true 表示允许,false 表示不允许。

📄 原文内容

Sends the “Allow” header to state all methods that can be sent to the current route.

Parameters

$responseWP_REST_Responserequired
Current response being served.
$serverWP_REST_Serverrequired
ResponseHandler instance (usually WP_REST_Server).
$requestWP_REST_Requestrequired
The request that was used to make current response.

Return

WP_REST_Response Response to be served, with “Allow” header if route has allowed methods.

Source

function rest_send_allow_header( $response, $server, $request ) {
	$matched_route = $response->get_matched_route();

	if ( ! $matched_route ) {
		return $response;
	}

	$routes = $server->get_routes();

	$allowed_methods = array();

	// Get the allowed methods across the routes.
	foreach ( $routes[ $matched_route ] as $_handler ) {
		foreach ( $_handler['methods'] as $handler_method => $value ) {

			if ( ! empty( $_handler['permission_callback'] ) ) {

				$permission = call_user_func( $_handler['permission_callback'], $request );

				$allowed_methods[ $handler_method ] = true === $permission;
			} else {
				$allowed_methods[ $handler_method ] = true;
			}
		}
	}

	// Strip out all the methods that are not allowed (false values).
	$allowed_methods = array_filter( $allowed_methods );

	if ( $allowed_methods ) {
		$response->header( 'Allow', implode( ', ', array_map( 'strtoupper', array_keys( $allowed_methods ) ) ) );
	}

	return $response;
}

Changelog

Version Description
4.4.0 Introduced.