public static function Request::setTrustedHeaderName

Sets the name for trusted headers.

The following header keys are supported:

• Request::HEADER_CLIENT_IP: defaults to X-Forwarded-For (see getClientIp())
• Request::HEADER_CLIENT_HOST: defaults to X-Forwarded-Host (see getClientHost())
• Request::HEADER_CLIENT_PORT: defaults to X-Forwarded-Port (see getClientPort())
• Request::HEADER_CLIENT_PROTO: defaults to X-Forwarded-Proto (see getScheme() and isSecure())

Setting an empty value allows to disable the trusted header for the given key.

Parameters

string $key The header key:

string $value The header name:

Throws

\InvalidArgumentException

File

drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Request.php, line 506

Class

Request

Request represents an HTTP request.

Namespace

Code

public static function setTrustedHeaderName($key, $value) {
  if (!array_key_exists($key, self::$trustedHeaders)) {
    throw new \InvalidArgumentException(sprintf('Unable to set the trusted header name for key "%s".', $key));
  }
  self::$trustedHeaders[$key] = $value;
}