rest_allowed_cors_headers filter-hookWP 5.5.0

Filters the list of request headers that are allowed for REST API CORS requests.

The allowed headers are passed to the browser to specify which headers can be passed to the REST API. By default, we allow the Content-* headers needed to upload files to the media endpoints. As well as the Authorization and Nonce headers for allowing authentication.

Usage

add_filter( 'rest_allowed_cors_headers', 'wp_kama_rest_allowed_cors_headers_filter' );

/**
 * Function for `rest_allowed_cors_headers` filter-hook.
 * 
 * @param string[] $allow_headers The list of request headers to allow.
 *
 * @return string[]
 */
function wp_kama_rest_allowed_cors_headers_filter( $allow_headers ){

	// filter...
	return $allow_headers;
}
$allow_headers(string[])
The list of request headers to allow.

Changelog

Since 5.5.0 Introduced.

Where the hook is called

WP_REST_Server::serve_request()
rest_allowed_cors_headers
wp-includes/rest-api/class-wp-rest-server.php 329
$allow_headers = apply_filters( 'rest_allowed_cors_headers', $allow_headers );

Where the hook is used in WordPress

Usage not found.