XMLHttpRequest の setRequestHeader() メソッドは、 HTTP リクエストヘッダーの値を設定します。 setRequestHeader() は、 open() の呼び出しの後、 send() の呼び出しの前に呼び出さなければなりません。同じヘッダーについてこのメソッドを複数回呼び出された場合は、複数の値が単一のリクエストヘッダーにマージされます。
最初に setRequestHeader() を呼び出した後、呼び出す度に、指定されたテキストは既存のヘッダーの内容の末尾に追加されます。
この関数を使用して Accept ヘッダーが設定されなかった場合、 send() が呼び出されると、 Accept ヘッダーは */* の値で送信されます。
セキュリティ上の理由で、いくつかのヘッダは、ユーザエージェントからしか制御できません。これらのヘッダーには、 禁止ヘッダー名 および 禁止レスポンスヘッダー名 を含みます。
注: カスタムフィールドについては、ドメインをまたがってリクエストを行うと、 "not allowed by Access-Control-Allow-Headers in preflight response" の例外に遭遇することがあります。この場合、サーバー側でレスポンスヘッダーに Access-Control-Allow-Headers を設定する必要があります。
構文
XMLHttpRequest.setRequestHeader(header, value)
引数
header- 値を設定するヘッダーの名前。
value- そのヘッダーの本体として設定する値。
返値
undefined です。
仕様書
| 仕様書 | 状態 | 備考 |
|---|---|---|
| XMLHttpRequest setRequestHeader() の定義 |
現行の標準 | WHATWG living standard |
ブラウザーの互換性
このページの互換性一覧表は構造化データから生成されています。データに協力していただけるのであれば、 https://github.com/mdn/browser-compat-data をチェックアウトしてプルリクエストを送信してください。
Update compatibility data on GitHub
| デスクトップ | モバイル | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
setRequestHeader | Chrome 完全対応 1 | Edge 完全対応 12 | Firefox 完全対応 1 | IE 完全対応 5 | Opera 完全対応 8 | Safari 完全対応 1.2 | WebView Android 完全対応 1 | Chrome Android 完全対応 18 | Firefox Android 完全対応 4 | Opera Android 完全対応 10.1 | Safari iOS 完全対応 1 | Samsung Internet Android 完全対応 1.0 |
凡例
- 完全対応
- 完全対応