[doc-en] master: SoapClient: clarify when context Authorization and Cookie headers are ignored (#5921)
| From: | Satvik Mishra via GitHub | Date: | Fri, 09 Oct 2026 10:43:13 +0000 |
| Subject: | [doc-en] master: SoapClient: clarify when context Authorization and Cookie headers are ignored (#5921) | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-23823@lists.php.net to get a copy of this message | ||
Author: Satvik Mishra (SatvikMishra08)
Committer: GitHub (web-flow)
Pusher: lacatoire
Date: 2026-10-09T12:43:09+02:00
Commit: https://github.com/php/doc-en/commit/cae7c5ca398c3fa91a227f425b518af26e1a6da0
Raw diff: https://github.com/php/doc-en/commit/cae7c5ca398c3fa91a227f425b518af26e1a6da0.diff
SoapClient: clarify when context Authorization and Cookie headers are ignored (#5921)
* SoapClient: clarify when context Authorization and Cookie headers are ignored
* Use simpara for inline-only paragraphs
* Apply review suggestions
Changed paths:
M reference/soap/soapclient/construct.xml
Diff:
diff --git a/reference/soap/soapclient/construct.xml b/reference/soap/soapclient/construct.xml
index 6b03cbd5871c..4b40a7ec831f 100644
--- a/reference/soap/soapclient/construct.xml
+++ b/reference/soap/soapclient/construct.xml
@@ -501,14 +501,24 @@
<literal>max_redirects</literal>,
<literal>protocol_version</literal>,
and <literal>user_agent</literal>.
</para>
- <para>
- Note that the following HTTP headers are generated automatically or from other
- options, and will be ignored if specified in the
<literal>'header'</literal>
- context option: <literal>host</literal>,
<literal>connection</literal>,
- <literal>user-agent</literal>,
<literal>content-length</literal>,
- <literal>content-type</literal>, <literal>cookie</literal>,
- <literal>authorization</literal>, and
<literal>proxy-authorization</literal>
- </para>
+ <simpara>
+ Note that the following <acronym>HTTP</acronym> headers are always generated
automatically or
+ from other options, and will be ignored if specified in the
+ <literal>'header'</literal> context option:
<literal>host</literal>,
+ <literal>connection</literal>, <literal>user-agent</literal>,
+ <literal>content-length</literal>, and
<literal>content-type</literal>.
+ </simpara>
+ <simpara>
+ The following headers are only ignored when the client generates them by itself:
+ <literal>authorization</literal> when the
+ <link linkend="soapclient.construct.options.login">login</link>
option is set,
+ <literal>proxy-authorization</literal> when proxy authentication is sent
using the
+ <link
linkend="soapclient.construct.options.proxy-login">proxy_login</link> option,
+ and <literal>cookie</literal> when the client has cookies to send, for
example ones set with
+ <methodname>SoapClient::__setCookie</methodname>.
+ Otherwise, they are passed through, so for example a bearer token can be sent
+ in an <literal>Authorization</literal> header through the context.
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="soapclient.construct.options.features">