常量 |
描述 |
curl_setopt()
CURLOPT_ABSTRACT_UNIX_SOCKET
(int)
|
允许使用抽象 Unix 域套接字而不是与主机建立 TCP 连接,并将路径设置为指定 string。此选项与
CURLOPT_UNIX_SOCKET_PATH 具有相同的语义。这两个选项共享相同的存储,因此每个句柄只能设置其中一个。自
PHP 7.3.0 和 cURL 7.53.0 起可用。
|
CURLOPT_ACCEPT_ENCODING
(int)
|
设置 string,其中包含 HTTP 请求中发送的 Accept-Encoding: 标头的内容。设置为
null 可禁用发送 Accept-Encoding: 标头。默认为 null 。自 cURL 7.21.6 起可用。
|
CURLOPT_ACCEPTTIMEOUT_MS
(int)
|
The maximum number of milliseconds to wait for a server
to connect back to cURL when an active FTP connection is used.
This option accepts any value that can be cast to a valid int.
Defaults to 60000 milliseconds.
Available as of cURL 7.24.0.
|
CURLOPT_ADDRESS_SCOPE
(int)
|
The scope id value to use when connecting to IPv6 addresses.
This option accepts any value that can be cast to a valid int.
Defaults to 0 .
Available as of cURL 7.19.0.
|
CURLOPT_ALTSVC
(int)
|
Pass a string with the filename for cURL to use as the Alt-Svc cache file to read existing cache contents from and
possibly also write it back to a after a transfer, unless CURLALTSVC_READONLYFILE
is set via CURLOPT_ALTSVC_CTRL .
Available as of PHP 8.2.0 and cURL 7.64.1.
|
CURLOPT_ALTSVC_CTRL
(int)
|
Populate the bitmask with the correct set of features to instruct cURL how to handle Alt-Svc for the
transfers using this handle. cURL only accepts Alt-Svc headers over HTTPS. It will also only complete
a request to an alternative origin if that origin is properly hosted over HTTPS.
Setting any bit will enable the alt-svc engine.
Set to any of the
CURLALTSVC_* constants.
Defaults to Alt-Svc handling being disabled.
Available as of PHP 8.2.0 and cURL 7.64.1.
|
CURLOPT_APPEND
(int)
|
Setting this option to 1 will cause FTP uploads
to append to the remote file instead of overwriting it.
Defaults to 0 .
Available as of cURL 7.17.0.
|
CURLOPT_AUTOREFERER
(int)
|
true 时将根据 Location: 重定向时,自动设置 header 中的 Referer:
信息。默认是 0 。自 cURL 7.1.0 起可用。
|
CURLOPT_AWS_SIGV4
(int)
|
Provides AWS V4 signature authentication on HTTP(S) header as a string.
This option overrides any other authentication types that have been set in
CURLOPT_HTTPAUTH . This method cannot be combined with other authentication types.
Available as of PHP 8.2.0 and cURL 7.75.0.
|
CURLOPT_BINARYTRANSFER
(int)
|
This constant is no longer used as of PHP 5.5.0.
Deprecated as of PHP 8.4.0.
|
CURLOPT_BUFFERSIZE
(int)
|
每次读取要使用的缓冲区大小。但不能保证此请求一定会得到满足。此选项接受任何可以转换为有效 int
的值。默认为 CURL_MAX_WRITE_SIZE (当前为 16kB)。自 cURL 7.10 起可用。
|
CURLOPT_CAINFO
(int)
|
包含一个或多个证书的文件名称的string,用于验证对等方。这仅在与
CURLOPT_SSL_VERIFYPEER 结合使用时才有意义。可能需要绝对路径。自
cURL 7.4.2 起可用。
|
CURLOPT_CAINFO_BLOB
(int)
|
A string with the name of a PEM file holding one or more certificates to verify the
peer with. This option overrides CURLOPT_CAINFO .
Available as of PHP 8.2.0 and cURL 7.77.0.
|
CURLOPT_CAPATH
(int)
|
A string with a directory that holds multiple CA certificates.
Use this option alongside CURLOPT_SSL_VERIFYPEER .
Available as of cURL 7.9.8.
|
CURLOPT_CA_CACHE_TIMEOUT
(int)
|
Sets the maximum time in seconds any in memory cached CA certificate store
may be kept and reused for new connections.
This option accepts any value that can be cast to a valid int.
Defaults to 86400 (24 hours).
Available as of PHP 8.3.0 and cURL 7.87.0
|
CURLOPT_CERTINFO
(int)
|
true 将在安全传输时输出 SSL 证书信息到 STDERR 。需要开启
CURLOPT_VERBOSE 才有效。默认为 false 。自 cURL 7.19.1 起可用。
|
CURLOPT_CONNECTTIMEOUT
(int)
|
在尝试连接时等待的秒数。设置为 0,则无限等待。此选项接受任何可以转换为有效 int
的值。默认 300 。自 cURL 7.7.0 起可用。
|
CURLOPT_CONNECTTIMEOUT_MS
(int)
|
尝试连接等待的时间,以毫秒为单位。设置为 0 ,则无限等待。如果 cURL
编译时使用系统标准的名称解析器(standard system name
resolver),那部分的连接仍旧使用以秒计的超时解决方案,最小超时时间还是一秒钟。此选项接受任何可以转换为有效 int
的值。默认 300000 。自 cURL 7.16.2 起可用。
|
CURLOPT_CONNECT_ONLY
(int)
|
true 将让库执行所有需要的代理、验证、连接过程,但不传输数据。此选项用于
HTTP、SMTP 和 POP3。默认是 false 。自 cURL 7.15.2 起可用。
|
CURLOPT_CONNECT_TO
(int)
|
连接到指定主机和端口,从而替换 URL 中的主机和端口。接受 string 格式的
array:HOST:PORT:CONNECT-TO-HOST:CONNECT-TO-PORT 。自
PHP 7.0.7 和 cURL 7.49.0 起可用。
|
CURLOPT_COOKIE
(int)
|
包含 HTTP 请求中使用的 Cookie: header 内容的 string。请注意,多个 Cookie
之间用分号分隔,后跟一个空格(例如,fruit=apple; colour=red )。自 cURL 7.1.0 起可用。
|
CURLOPT_COOKIEFILE
(int)
|
包含 cookie 数据的文件的名称 string。cookie 文件可以是 Netscape 格式,也可以只是转储到文件中的纯
HTTP 样式标头。如果名称为空 string,则不会加载任何 cookie,但仍启用 cookie 处理。自 cURL 7.1.0 起可用。
|
CURLOPT_COOKIEJAR
(int)
|
string,包含调用句柄的析构函数时用于保存所有内部 cookie 的文件的名称。自 cURL 7.9.0 起可用。
|
CURLOPT_COOKIELIST
(int)
|
cookie string(即 Netscape/Mozilla 的单行格式,或常规 HTTP 样式的 Set-Cookie header)将单个
cookie 添加到内部 cookie 存储中。
ALL
擦除内存中保存的所有 cookie
,
SESS
擦除内存中保存的所有会话 cookie
,
FLUSH
将所有已知的 cookie 写入到 CURLOPT_COOKIEJAR 指定的文件
,
RELOAD
从 CURLOPT_COOKIEFILE 指定的文件中加载所有 cookie
.
自 cURL 7.14.1 起可用。
|
CURLOPT_COOKIESESSION
(int)
|
设为 true 时将开启新的 cookie“会话”。将强制 cURL 忽略之前会话时存的其他 cookie。cURL
在默认情况下无论是否为会话,都会储存、加载所有 cookie。会话 cookie
是指没有过期时间,只存活在会话之中。自 cURL 7.9.7 起可用。
|
CURLOPT_CRLF
(int)
|
true 表示将 Unix 换行符转换成 CRLF 换行符。自 cURL 7.1.0 起可用。
|
CURLOPT_CRLFILE
(int)
|
Pass a string naming a file with the concatenation of
CRL (Certificate Revocation List) (in PEM format)
to use in the certificate validation that occurs during the SSL exchange.
When cURL is built to use GnuTLS,
there is no way to influence the use of CRL passed
to help in the verification process.
When cURL is built with OpenSSL support,
X509_V_FLAG_CRL_CHECK
and X509_V_FLAG_CRL_CHECK_ALL are both set,
requiring CRL check against all the elements of the certificate chain
if a CRL file is passed.
Also note that CURLOPT_CRLFILE implies
CURLSSLOPT_NO_PARTIALCHAIN
as of cURL 7.71.0 due to an OpenSSL bug.
Available as of cURL 7.19.0.
|
CURLOPT_CUSTOMREQUEST
(int)
|
HTTP 请求时,使用自定义的请求方法来代替 GET 或 HEAD 。对
DELETE 或者其他更隐蔽的 HTTP 请求有用。有效值如 GET 、POST ,CONNECT
等等;也就是说,不要在这里输入整行 HTTP 请求。例如输入 GET /index.html HTTP/1.0\r\n\r\n
是不正确的。此选项接受 string 或 null 。自 cURL 7.1.0 起可用。
注意:
在没有首先确保服务器支持自定义请求方法的情况下,不要执行此操作。
|
CURLOPT_DEFAULT_PROTOCOL
(int)
|
URL 缺少协议的时候,使用 string 格式的默认协议。自 PHP 7.0.7 和 cURL 7.45.0 起可用。
|
CURLOPT_DIRLISTONLY
(int)
|
Setting this option to 1 will have different effects
based on the protocol it is used with.
FTP and SFTP based URLs will list only the names of files in a directory.
POP3 will list the email message or messages on the POP3 server.
For FILE, this option has no effect
as directories are always listed in this mode.
Using this option with CURLOPT_WILDCARDMATCH
will prevent the latter from having any effect.
Defaults to 0 .
Available as of cURL 7.17.0.
|
CURLOPT_DISALLOW_USERNAME_IN_URL
(int)
|
true to not allow URLs that include a username.
Usernames are allowed by default.
Available as of PHP 7.3.0 and cURL 7.61.0.
|
CURLOPT_DNS_CACHE_TIMEOUT
(int)
|
设置在内存中缓存 DNS 的时间,默认为 120 秒(2 分钟)。此选项接受任何可以转换为有效
int 的值。自 cURL 7.9.3 起可用。
|
CURLOPT_DNS_INTERFACE
(int)
|
Set the name of the network interface that the DNS resolver should bind to.
This must be an interface name (not an address).
This option accepts a string or null .
Available as of PHP 7.0.7 and cURL 7.33.0
|
CURLOPT_DNS_LOCAL_IP4
(int)
|
Set the local IPv4 address that the resolver should bind to.
The argument should contain a single numerical IPv4 address.
This option accepts a string or null .
Available as of PHP 7.0.7 and cURL 7.33.0.
|
CURLOPT_DNS_LOCAL_IP6
(int)
|
Set the local IPv6 address that the resolver should bind to.
The argument should contain a single numerical IPv6 address.
This option accepts a string or null .
Available as of PHP 7.0.7 and cURL 7.33.0.
|
CURLOPT_DNS_SERVERS
(int)
|
Pass a string with a comma-separated list of DNS servers to be used
instead of the system default
(e.g.: 192.168.1.100,192.168.1.101:8080 ).
Available as of cURL 7.24.0.
|
CURLOPT_DNS_SHUFFLE_ADDRESSES
(int)
|
true to shuffle the order of all returned addresses so that they will be used
in a random order, when a name is resolved and more than one IP address is returned.
This may cause IPv4 to be used before IPv6 or vice versa.
Available as of PHP 7.3.0 and cURL 7.60.0.
|
CURLOPT_DNS_USE_GLOBAL_CACHE
(int)
|
true 表示使用全局 DNS 缓存。此选项非线程安全。如果 PHP 是为非线程使用(CLI、FCGI、Apache2-Prefork
等)构建的,则默认情况下会有条件性的启用此选项。自 cURL 7.9.3 起可用,自 cURL 7.11.1 起弃用。自
PHP 8.4 起,此选项不再有效。
|
CURLOPT_DOH_SSL_VERIFYHOST
(int)
|
Set to 2 to verify the DNS-over-HTTPS server's SSL certificate name fields against the host name.
Available as of PHP 8.2.0 and cURL 7.76.0.
|
CURLOPT_DOH_SSL_VERIFYPEER
(int)
|
Set to 1 to enable and 0 to disable
verification of the authenticity of the DNS-over-HTTPS server's SSL certificate.
Available as of PHP 8.2.0 and cURL 7.76.0.
|
CURLOPT_DOH_SSL_VERIFYSTATUS
(int)
|
Set to 1 to enable and 0 to disable
the verification of the status of the DNS-over-HTTPS server certificate
using the "Certificate Status Request" TLS extension (OCSP stapling).
Available as of PHP 8.2.0 and cURL 7.76.0.
|
CURLOPT_DOH_URL
(int)
|
Provides the DNS-over-HTTPS URL.
This option accepts a string or null .
Available as of PHP 8.1.0 and cURL 7.62.0.
|
CURLOPT_EGDSOCKET
(int)
|
Like CURLOPT_RANDOM_FILE , except a filename
to an Entropy Gathering Daemon socket.
Available as of cURL 7.7.0 and deprecated as of cURL 7.84.0.
|
CURLOPT_ENCODING
(int)
|
The contents of the Accept-Encoding: header as a string.
This enables decoding of the response. Supported encodings are:
identity , deflate , gzip .
If an empty string is set,
a header containing all supported encoding types is sent.
Available as of cURL 7.10 and deprecated as of cURL 7.21.6.
|
CURLOPT_EXPECT_100_TIMEOUT_MS
(int)
|
Expect: 100-continue 响应的超时时间,以毫秒为单位。默认为 1000
毫秒。此选项接受任何可以转换为有效 int 的值。自 PHP 7.0.7 和 cURL 7.36.0 起可用。
|
CURLOPT_FAILONERROR
(int)
|
当 HTTP 状态码大于等于 400 ,true 将显示错误详情。默认情况下将返回页面,忽略
HTTP 代码。自 cURL 7.1.0 起可用。
|
CURLOPT_FILE
(int)
|
Accepts a file handle resource
to the file that the transfer should be written to.
The default is STDOUT (the browser window).
Available as of cURL 7.1.0 and deprecated as of cURL 7.9.7.
|
CURLOPT_FILETIME
(int)
|
设置为 true 时,会尝试获取远程文档中的修改时间信息。此值可通过 curl_getinfo()
函数的 CURLINFO_FILETIME 选项获取。自 cURL 7.5.0 起可用。
|
CURLOPT_FNMATCH_FUNCTION
(int)
|
Pass a callable that will be used for wildcard matching.
The signature of the callback should be:
curlHandle
-
The cURL handle.
pattern
-
The wildcard pattern.
string
-
The string to run the wildcard pattern matching on.
The callback should return
CURL_FNMATCHFUNC_MATCH if pattern matches the string,
CURL_FNMATCHFUNC_NOMATCH if not
or CURL_FNMATCHFUNC_FAIL if an error occurred.
Available as of cURL 7.21.0.
|
CURLOPT_FOLLOWLOCATION
(int)
|
设置为 true 时将会根据服务器返回 HTTP header 中的 Location: 重定向。参
CURLOPT_MAXREDIRS 。当 open_basedir 启用时,此常量无效。自 cURL 7.1.0 起可用。
|
CURLOPT_FORBID_REUSE
(int)
|
设置为 true 后,在完成交互以后强制断开连接,不能在连接池中重用。自 cURL 7.7.0 起可用。
|
CURLOPT_FRESH_CONNECT
(int)
|
设置为 true 强制获取新连接,而不是缓存中的连接。自 cURL 7.7.0 起可用。
|
CURLOPT_FTPAPPEND
(int)
|
设置为 true 时为追加写入文件,而不是覆盖。自 cURL 7.1.0 起可用并于 cURL 7.16.4 起弃用。
|
CURLOPT_FTPASCII
(int)
|
CURLOPT_TRANSFERTEXT 的别名。请改用 CURLOPT_TRANSFERTEXT 。自
cURL 7.1 起可用,自 cURL 7.11.1 起弃用,最后在 cURL 7.15.5 中可用。自 PHP 7.3.0 起移除。
|
CURLOPT_FTPLISTONLY
(int)
|
设置为 true 时只列出 FTP 目录的名称。自 cURL 7.1.0 起可用并于 cURL 7.16.4 起弃用。
|
CURLOPT_FTPPORT
(int)
|
A string which will be used to get the IP address to use for the FTP PORT instruction. The PORT instruction tells
the remote server to connect to our specified IP address. The
string may be a plain IP address, a hostname,
a network interface name (under Unix),
or just a plain - to use the system's default IP address.
This option accepts a string or null .
Available as of cURL 7.1.0.
|
CURLOPT_FTPSSLAUTH
(int)
|
将 FTP over SSL 身份验证方法(如果已启用)设置为任何 CURLFTPAUTH_*
常量。默认 CURLFTPAUTH_DEFAULT 。自 cURL 7.12.2 起可用。
|
CURLOPT_FTP_ACCOUNT
(int)
|
Pass a string that will be sent as account information over FTP
(using the ACCT command) after username and password has been provided
to the server.
Set to null to disable sending the account information.
Defaults to null .
Available as of cURL 7.13.0.
|
CURLOPT_FTP_ALTERNATIVE_TO_USER
(int)
|
Pass a string that will be used to try to authenticate over FTP
if the USER/PASS negotiation fails.
Available as of cURL 7.15.5.
|
CURLOPT_FTP_CREATE_MISSING_DIRS
(int)
|
设置为 true 时在 FTP 操作遇到当前不存在的路径时会创建缺失的目录。自 cURL 7.10.7 起可用。
|
CURLOPT_FTP_FILEMETHOD
(int)
|
Tell cURL which method to use to reach a file on a FTP(S) server. Possible values are
any of the CURLFTPMETHOD_* constants.
Defaults to CURLFTPMETHOD_MULTICWD .
Available as of cURL 7.15.1.
|
CURLOPT_FTP_RESPONSE_TIMEOUT
(int)
|
A timeout in seconds cURL will wait for a response from an FTP server.
This option overrides CURLOPT_TIMEOUT .
This option accepts any value that can be cast to a valid int.
This option name is replaced with CURLOPT_SERVER_RESPONSE_TIMEOUT ,
available as of PHP 8.4.0.
Available as of cURL 7.10.8 and deprecated as of cURL 7.85.0.
|
CURLOPT_FTP_SKIP_PASV_IP
(int)
|
If this option is set to 1
cURL will not use the IP address the server suggests
in its 227-response to cURL's PASV command
but will use the IP address it used for the connection.
The port number received from the 227-response will not be ignored by cURL.
Defaults to 1 as of cURL 7.74.0
and 0 prior to that.
Available as of cURL 7.15.0.
|
CURLOPT_FTP_SSL
(int)
|
Available as of cURL 7.11.0 and deprecated as of cURL 7.16.4.
|
CURLOPT_FTP_SSL_CCC
(int)
|
This option makes cURL use CCC (Clear Command Channel)
which shuts down the SSL/TLS layer after authenticating
making the rest of the control channel communication unencrypted.
Use one of the CURLFTPSSL_CCC_* constants.
Defaults to CURLFTPSSL_CCC_NONE .
Available as of cURL 7.16.1.
|
CURLOPT_FTP_USE_EPRT
(int)
|
设置为 true 时,当 FTP 下载时,使用 EPRT (和 LPRT )命令。设置为 false
时禁用 EPRT 和 LPRT ,仅仅使用 PORT 命令。自
cURL 7.10.5 起可用。
|
CURLOPT_FTP_USE_EPSV
(int)
|
设置为 true 时,在 FTP 传输过程中,回到 PASV 模式前,先尝试 EPSV 命令。设置为
false 时禁用 EPSV 。自 cURL 7.9.2 起可用。
|
CURLOPT_FTP_USE_PRET
(int)
|
Set to 1 to send a PRET command
before PASV (and EPSV ).
Has no effect when using the active FTP transfers mode.
Defaults to 0 .
Available as of cURL 7.20.0.
|
CURLOPT_GSSAPI_DELEGATION
(int)
|
Set to CURLGSSAPI_DELEGATION_FLAG
to allow unconditional GSSAPI credential delegation.
Set to CURLGSSAPI_DELEGATION_POLICY_FLAG
to delegate only if the OK-AS-DELEGATE flag is set
in the service ticket.
Defaults to CURLGSSAPI_DELEGATION_NONE .
Available as of cURL 7.22.0.
|
CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS
(int)
|
Head start for IPv6 for the happy eyeballs algorithm. Happy eyeballs attempts
to connect to both IPv4 and IPv6 addresses for dual-stack hosts,
preferring IPv6 first for timeout milliseconds.
Defaults to CURL_HET_DEFAULT , which is currently 200 milliseconds.
This option accepts any value that can be cast to a valid int.
Available as of PHP 7.3.0 and cURL 7.59.0
|
CURLOPT_HAPROXYPROTOCOL
(int)
|
true to send an HAProxy PROXY protocol v1 header at the start of the connection.
The default action is not to send this header.
Available as of PHP 7.3.0 and cURL 7.60.0.
|
设置为 true 以将 header 包含在发送到 CURLOPT_WRITEFUNCTION
定义的回调的输出中。自 cURL 7.1.0 起可用。
|
A callable with the following signature:
curlHandle
-
The cURL handle.
headerData
-
The header data which must be written by the callback.
The callback should return the number of bytes written.
Available as of cURL 7.7.2.
|
将 HTTP header 同时发送到代理和主机或单独发送。可能的值是 CURLHEADER_*
常量。自 cURL 7.42.1 起默认 CURLHEADER_SEPARATE ,在此之前默认为
CURLHEADER_UNIFIED 。自 PHP 7.0.7 和 cURL 7.37.0 起可用。
|
CURLOPT_HSTS
(int)
|
string with HSTS (HTTP Strict Transport Security) cache file name
or null to allow HSTS without reading from or writing to any file
and clear the list of files to read HSTS data from.
Available as of PHP 8.2.0 and cURL 7.74.0.
|
CURLOPT_HSTS_CTRL
(int)
|
Accepts a bitmask of HSTS (HTTP Strict Transport Security) features
defined by the CURLHSTS_* constants.
Available as of PHP 8.2.0 and cURL 7.74.0.
|
CURLOPT_HTTP09_ALLOWED
(int)
|
是否允许 HTTP/0.9 响应。从 cURL 7.66.0 起默认为 false ;以前默认为 true 。分别自
PHP 7.3.15 和 7.4.3 以及 cURL 7.64.0 起可用。
|
CURLOPT_HTTP200ALIASES
(int)
|
An array of HTTP 200 responses that will be treated as valid responses and not as errors.
Available as of cURL 7.10.3.
|
CURLOPT_HTTPAUTH
(int)
|
使用的 HTTP 验证方法。选项有:
CURLAUTH_BASIC , CURLAUTH_DIGEST , CURLAUTH_GSSNEGOTIATE , CURLAUTH_NTLM , CURLAUTH_AWS_SIGV4 , CURLAUTH_ANY , CURLAUTH_ANYSAFE 。如果使用多种方法,cURL 将轮询服务器以查看它支持哪些方法并选择最佳方法。CURLAUTH_ANY
设置所有的位。cURL 将自动选择它认为最安全的一个。CURLAUTH_ANYSAFE 设置了除
CURLAUTH_BASIC 以外所有的位。cURL 将自动选择它认为最安全的一个。自 cURL 7.10.6 起可用。
|
CURLOPT_HTTPGET
(int)
|
设置为 true 时会设置 HTTP 方法为 GET ,由于默认是
GET ,所以只有修改请求方法时才需要这个选项。自 cURL 7.8.1 起可用。
|
An array of HTTP header fields to set, in the format
array('Content-type: text/plain', 'Content-length: 100')
Available as of cURL 7.1.0.
|
CURLOPT_HTTPPROXYTUNNEL
(int)
|
true 会通过指定 HTTP 代理来传输。自 cURL 7.3.0 起可用。
|
CURLOPT_HTTP_CONTENT_DECODING
(int)
|
false 时获取原始 HTTP 响应主体。自 cURL 7.16.2 起可用。
|
CURLOPT_HTTP_TRANSFER_DECODING
(int)
|
If set to 0 , transfer decoding is disabled.
If set to 1 , transfer decoding is enabled.
cURL does chunked transfer decoding by default
unless this option is set to 0 .
Defaults to 1 .
Available as of cURL 7.16.2.
|
CURLOPT_HTTP_VERSION
(int)
|
设置为 CURL_HTTP_VERSION_* 常量中的一个,以便
cURL 使用指定的 HTTP 版本。自 cURL 7.9.1 起可用。
|
CURLOPT_IGNORE_CONTENT_LENGTH
(int)
|
If set to 1 ,
ignore the Content-Length header in the HTTP response
and ignore asking for or relying on it for FTP transfers.
Defaults to 0 .
Available as of cURL 7.14.1.
|
CURLOPT_INFILE
(int)
|
Accepts a file handle resource
to the file that the transfer should be read from when uploading.
Available as of cURL 7.1.0 and deprecated as of cURL 7.9.7.
Use CURLOPT_READDATA instead.
|
CURLOPT_INFILESIZE
(int)
|
希望传给远程站点的文件字节大小。注意无法用这个选项阻止 cURL 发送更多的数据,确切发送什么取决于
CURLOPT_READFUNCTION 。此选项接受任何可以转换为有效 int
的值。自 cURL 7.1.0 起可用。
|
CURLOPT_INTERFACE
(int)
|
Set to a string with the name of the outgoing network interface to use.
This can be an interface name, an IP address or a host name.
Available as of cURL 7.1.0.
|
CURLOPT_IPRESOLVE
(int)
|
允许应用程序选择在解析主机名时使用哪种 IP 地址。这仅在使用解析使用多个 IP 版本的地址的主机名时才有意义。设置为
CURL_IPRESOLVE_* 常量中的一个。默认为
CURL_IPRESOLVE_WHATEVER 。自 cURL 7.10.8 起可用。
|
CURLOPT_ISSUERCERT
(int)
|
If set to a string naming a file holding a CA certificate in PEM format,
an additional check against the peer certificate is performed
to verify the issuer is indeed the one associated
with the certificate provided by the option.
For the result of the check to be considered a failure,
this option should be used in combination with the
CURLOPT_SSL_VERIFYPEER option.
Available as of cURL 7.19.0.
|
CURLOPT_ISSUERCERT_BLOB
(int)
|
Pass a string with binary data of a CA SSL certificate in PEM format.
If set, an additional check against the peer certificate is performed
to verify the issuer is the one associated with the certificate provided by the option.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_KEEP_SENDING_ON_ERROR
(int)
|
设置为 true 时,如果返回的 HTTP 代码等于或大于
300 ,则继续发送请求主体。默认操作是停止发送并关闭流或连接。适用于手动 NTLM
身份验证。大多数应用程序不需要此选项。自 PHP 7.3.0 和 cURL 7.51.0 起可用。
|
CURLOPT_KEYPASSWD
(int)
|
Set to a string with the password required to use the CURLOPT_SSLKEY
or CURLOPT_SSH_PRIVATE_KEYFILE private key.
Setting this option to null disables using a password for these options.
Available as of cURL 7.17.0.
|
CURLOPT_KRB4LEVEL
(int)
|
The KRB4 (Kerberos 4) security level. Any of the following string values
(in order from least to most powerful) are valid:
clear , safe , confidential , private .
If the string does not match one of these,
private is used. Setting this option to null
will disable KRB4 security. Currently KRB4 security only works
with FTP transactions.
Available as of cURL 7.3.0 and deprecated as of cURL 7.17.0.
|
CURLOPT_KRBLEVEL
(int)
|
Set the kerberos security level for FTP and also enables kerberos awareness.
This should be set to one of the following strings:
clear , safe , confidential , private .
If the string is set but does not match one of these,
private is used.
Setting this option to null will disable kerberos support for FTP.
Defaults to null .
Available as of cURL 7.16.4.
|
CURLOPT_LOCALPORT
(int)
|
Sets the local port number of the socket used for the connection.
This option accepts any value that can be cast to a valid int.
Defaults to 0 .
Available as of cURL 7.15.2.
|
CURLOPT_LOCALPORTRANGE
(int)
|
The number of attempts cURL makes to find a working local port number,
starting with the one set with CURLOPT_LOCALPORT .
This option accepts any value that can be cast to a valid int.
Defaults to 1 .
Available as of cURL 7.15.2.
|
CURLOPT_LOGIN_OPTIONS
(int)
|
Can be used to set protocol specific login options, such as the
preferred authentication mechanism via AUTH=NTLM or AUTH=* , and should be used in conjunction with the
CURLOPT_USERNAME option.
Available as of PHP 7.0.7 and cURL 7.34.0.
|
CURLOPT_LOW_SPEED_LIMIT
(int)
|
传输速度,每秒字节数,根据 CURLOPT_LOW_SPEED_TIME
秒数统计是否因太慢而取消传输。此选项接受任何可以转换为有效 int
的值。自 cURL 7.1.0 起可用。
|
CURLOPT_LOW_SPEED_TIME
(int)
|
当传输速度小于 CURLOPT_LOW_SPEED_LIMIT 时(bytes/sec),PHP
会判断是否因太慢而取消传输。此选项接受任何可以转换为有效 int
的值。自 cURL 7.1.0 起可用。
|
CURLOPT_MAIL_AUTH
(int)
|
Set a string with the authentication address (identity)
of a submitted message that is being relayed to another server.
The address should not be specified within a pair of angled brackets
(>< ).
If an empty string is used then a pair of brackets are sent by cURL
as required by RFC 2554.
Available as of cURL 7.25.0.
|
CURLOPT_MAIL_FROM
(int)
|
Set a string with the sender's email address when sending SMTP mail.
The email address should be specified with angled brackets
(>< ) around it,
which if not specified are added automatically.
If this parameter is not specified then an empty address is sent
to the SMTP server which might cause the email to be rejected.
Available as of cURL 7.20.0.
|
CURLOPT_MAIL_RCPT
(int)
|
Set to an array of strings
with the recipients to pass to the server in an SMTP mail request.
Each recipient should be specified within a pair of angled brackets
(>< ).
If an angled bracket is not used as the first character,
cURL assumes a single email address has been provided
and encloses that address within brackets.
Available as of cURL 7.20.0.
|
CURLOPT_MAIL_RCPT_ALLLOWFAILS
(int)
|
设置为 1 以允许 RCPT TO 命令对某些收件人失败,这会使 cURL
忽略个别收件人的错误并继续处理其余已接受的收件人。如果所有收件人触发失败并且设置了此 flag,cURL 将中止
SMTP 对话并返回从最后一个 RCPT TO 命令收到的错误。自 cURL 8.2.0 起由
CURLOPT_MAIL_RCPT_ALLOWFAILS 取代。自 PHP 8.2.0 和 cURL 7.69.0
起可用。自 cURL 8.2.0 起弃用。
|
CURLOPT_MAXAGE_CONN
(int)
|
重新使用已存在连接时允许的最大空闲时间。默认最大时间设置为 118
秒。此选项接受任何可以转换为有效 int 的值。自 PHP 8.2.0 和 cURL 7.65.0 起可用。
|
CURLOPT_MAXCONNECTS
(int)
|
允许的最大持久连接数。当达到限制时,将会关闭缓存中最早的连接,以防止增加已打开的连接数。此选项接受任何可以转换为有效
int 的值。自 cURL 7.7.0 起可用。
|
CURLOPT_MAXFILESIZE
(int)
|
Sets the maximum accepted size (in bytes) of a file to download.
If the file requested is found larger than this value,
the transfer is aborted
and CURLE_FILESIZE_EXCEEDED is returned.
Passing 0 disables this option,
and passing a negative size returns a
CURLE_BAD_FUNCTION_ARGUMENT .
If the file size is not known prior to the start of download,
this option has no effect.
For setting a size limit above 2GB ,
CURLOPT_MAXFILESIZE_LARGE should be used.
As of cURL 8.4.0, this option also stops ongoing transfers
if they reach this threshold.
This option accepts any value that can be cast to a valid int.
Defaults to 0 .
Available as of cURL 7.10.8.
|
CURLOPT_MAXFILESIZE_LARGE
(int)
|
The maximum file size in bytes allowed to download. If the file requested is found larger than this value,
the transfer will not start and CURLE_FILESIZE_EXCEEDED will be returned.
The file size is not always known prior to download, and for such files this option has no effect even if
the file transfer ends up being larger than this given limit.
This option accepts any value that can be cast to a valid int.
Available as of PHP 8.2.0 and cURL 7.11.0.
|
CURLOPT_MAXLIFETIME_CONN
(int)
|
The maximum time in seconds, since the creation of the connection, that is allowed for an existing
connection to have for it to be considered for reuse. If a connection is found in the cache that is older
than this value, it will instead be closed once any in-progress transfers are complete.
Default is 0 seconds, meaning the option is disabled and all connections are eligible for reuse.
This option accepts any value that can be cast to a valid int.
Available as of PHP 8.2.0 and cURL 7.80.0.
|
CURLOPT_MAXREDIRS
(int)
|
指定最多的 HTTP 重定向次数,这个选项是和 CURLOPT_FOLLOWLOCATION 一起使用的。默认值 20
是为了防止无限重定向。设置为 -1 允许无限重定向,0 拒绝所有重定向。自 cURL 7.5.0 起可用。
|
CURLOPT_MAX_RECV_SPEED_LARGE
(int)
|
如果下载速度超过了此速度(以每秒字节数来统计),即传输过程中累计的平均数,传输就会降速到这个参数的值。默认不限速。
This option accepts any value that can be cast to a valid int.
Available as of cURL 7.15.5.
|
CURLOPT_MAX_SEND_SPEED_LARGE
(int)
|
如果上传的速度超过了此速度(以每秒字节数来统计),即传输过程中累计的平均数,传输就会降速到这个参数的值。默认不限速。
This option accepts any value that can be cast to a valid int.
Available as of cURL 7.15.5.
|
CURLOPT_MIME_OPTIONS
(int)
|
Set to a bitmask of CURLMIMEOPT_*
constants. Currently there is only one available option:
CURLMIMEOPT_FORMESCAPE .
Available as of PHP 8.3.0 and cURL 7.81.0.
|
CURLOPT_MUTE
(int)
|
设置 true 时将完全静默,无论是何 cURL 函数。使用 CURLOPT_RETURNTRANSFER
代替。自 cURL 7.1.0 起可用,自 cURL 7.8.0 起弃用,最后在 cURL 7.15.5 中可用。自 PHP 7.3.0 起移除。
|
CURLOPT_NETRC
(int)
|
设置为 true 时,在连接建立时,访问 ~/.netrc
文件获取用户名和密码来连接远程站点。自 cURL 7.1.0 起可用。
|
CURLOPT_NETRC_FILE
(int)
|
Set a string containing the full path name to a .netrc file.
If this option is omitted and CURLOPT_NETRC is set,
cURL checks for a .netrc file
in the current user's home directory.
Available as of cURL 7.11.0.
|
CURLOPT_NEW_DIRECTORY_PERMS
(int)
|
Sets the value of the permissions (int) that is set on newly created directories
on the remote server. The default value is 0755 .
The only protocols that can use this are
sftp:// , scp://
and file:// .
Available as of cURL 7.16.4.
|
CURLOPT_NEW_FILE_PERMS
(int)
|
Sets the value of the permissions (as an int) that are set on newly created files
on the remote server. The default value is 0644 .
The only protocols that can use this are
sftp:// , scp://
and file:// .
Available as of cURL 7.16.4.
|
CURLOPT_NOBODY
(int)
|
设置为 true 可从输出中排除正文。对于 HTTP(S),cURL 会发出 HEAD 请求。对于大多数其他协议,cURL
根本不会要求正文数据。将其更改为 false 将导致正文数据包含在输出中。自 cURL 7.1.0 起可用。
|
CURLOPT_NOPROGRESS
(int)
|
设置为 true 时关闭 cURL 的传输进度。
注意:
PHP 自动设置此选项为 true ,只有用于调试才需要改变设置。
自 cURL 7.1.0 起可用。
|
CURLOPT_NOPROXY
(int)
|
Set a string consisting of a comma separated list of hostnames
that do not require a proxy to get reached.
Each name in this list is matched as either a domain
which contains the hostname or the hostname itself.
The only wildcard available in the string
is a single * character which matches all hosts,
effectively disabling the proxy.
Setting this option to an empty string enables the proxy for all hostnames.
Since cURL 7.86.0, IP addresses set with this option
can be provided using CIDR notation.
Available as of cURL 7.19.4.
|
CURLOPT_NOSIGNAL
(int)
|
true 时忽略所有的 cURL 函数传递给 PHP 进程的信号。在 SAPI
多线程传输时默认启用此选项,所以超时选项仍能使用。自 cURL 7.10 起可用。
|
CURLOPT_PASSWDFUNCTION
(int)
|
A callable with the following signature:
curlHandle
-
The cURL handle.
passwordPrompt
-
A password prompt.
maximumPasswordLength
-
The maximum length of the password.
The callback should return a string containing the password.
Available as of cURL 7.4.2, deprecated as of cURL 7.11.1
and last available in cURL 7.15.5.
Removed as of PHP 7.3.0.
|
CURLOPT_PASSWORD
(int)
|
Set to a string with the password to use in authentication.
Available as of cURL 7.19.1.
|
CURLOPT_PATH_AS_IS
(int)
|
Set to true for cURL not alter URL paths before passing them on to the server.
Defaults to false , which squashes sequences of /../
or /./ that may exist in the URL's path part
which is supposed to be removed according to RFC 3986 section 5.2.4.
Available as of PHP 7.0.7 and cURL 7.42.0.
|
CURLOPT_PINNEDPUBLICKEY
(int)
|
Set a string with the pinned public key.
The string can be the file name of the pinned public key
in a PEM or DER file format. The string can also be any
number of base64 encoded sha256 hashes preceded by sha256// and
separated by ; .
Available as of PHP 7.0.7 and cURL 7.39.0.
|
CURLOPT_PIPEWAIT
(int)
|
Set to true to wait for an existing connection to confirm
whether it can do multiplexing and use it if it can
before creating and using a new connection.
Available as of PHP 7.0.7 and cURL 7.43.0.
|
CURLOPT_PORT
(int)
|
An int with an alternative port number to connect to
instead of the one specified in the URL or the default port for the used protocol.
Available as of cURL 7.1.0.
|
CURLOPT_POST
(int)
|
设置为 true 用于执行 HTTP POST 请求。此请求使用
application/x-www-form-urlencoded header。默认为 false 。自 cURL 7.1.0 起可用。
|
CURLOPT_POSTFIELDS
(int)
|
The full data to post in a HTTP POST operation.
This parameter can either be
passed as a urlencoded string like 'para1=val1¶2=val2&... '
or as an array with the field name as key and field data as value.
If value is an array, the
Content-Type header will be set to
multipart/form-data .
Files can be sent using CURLFile or CURLStringFile,
in which case value must be an array.
Available as of cURL 7.1.0.
|
CURLOPT_POSTQUOTE
(int)
|
An array of FTP command strings
to execute on the server after the FTP request has been performed.
Available as of cURL 7.1.0.
|
CURLOPT_POSTREDIR
(int)
|
位掩码,CURL_REDIR_POST_301 、CURL_REDIR_POST_302
和 CURL_REDIR_POST_303 。当设置 CURLOPT_FOLLOWLOCATION
并发生了特定类型的重定向时,是否需要再次 HTTP POST 到重定向网址。自 cURL 7.19.1 起可用。
|
CURLOPT_PRE_PROXY
(int)
|
Set a string holding the host name or dotted numerical
IP address to be used as the preproxy that cURL connects to before
it connects to the HTTP(S) proxy specified in the
CURLOPT_PROXY option for the upcoming request.
The preproxy can only be a SOCKS proxy and it should be prefixed with
[scheme]:// to specify which kind of socks is used.
A numerical IPv6 address must be written within [brackets].
Setting the preproxy to an empty string explicitly disables the use of a preproxy.
To specify port number in this string, append :[port]
to the end of the host name. The proxy's port number may optionally be
specified with the separate option CURLOPT_PROXYPORT .
Defaults to using port 1080 for proxies if a port is not specified.
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PREQUOTE
(int)
|
Set an array of FTP command strings to pass to the server
after the transfer type is set.
These commands are not performed when a directory listing is performed,
only for file transfers.
Available as of cURL 7.9.5.
|
CURLOPT_PRIVATE
(int)
|
Any data that should be associated with this cURL handle. This data
can subsequently be retrieved with the
CURLINFO_PRIVATE option of
curl_getinfo(). cURL does nothing with this data.
When using a cURL multi handle, this private data is typically a
unique key to identify a standard cURL handle.
Available as of cURL 7.10.3.
|
CURLOPT_PROGRESSFUNCTION
(int)
|
A callable with the following signature:
callback( resource $curlHandle , int $bytesToDownload , int $bytesDownloaded , int $bytesToUpload , int $bytesUploaded ): int
curlHandle
-
The cURL handle.
bytesToDownload
-
The total number of bytes expected to be downloaded in this transfer.
bytesDownloaded
-
The number of bytes downloaded so far.
bytesToUpload
-
The total number of bytes expected to be uploaded in this transfer.
bytesUploaded
-
The number of bytes uploaded so far.
The callback should return an int with a non-zero value to abort the transfer
and set a CURLE_ABORTED_BY_CALLBACK error.
注意:
The callback is only called when the CURLOPT_NOPROGRESS
option is set to false .
Available as of cURL 7.1.0 and deprecated as of cURL 7.32.0.
Use CURLOPT_XFERINFOFUNCTION instead.
|
CURLOPT_PROTOCOLS
(int)
|
Bitmask of CURLPROTO_* values.
If used, this bitmask limits what protocols cURL may use in the transfer.
Defaults to CURLPROTO_ALL , ie. cURL will accept all protocols it supports.
See also CURLOPT_REDIR_PROTOCOLS .
Available as of cURL 7.19.4 and deprecated as of cURL 7.85.0.
|
CURLOPT_PROTOCOLS_STR
(int)
|
Set to a string with a comma separated list
of case insensitive protocol names (URL schemes) to allow in the transfer.
Set to ALL to enable all protocols.
By default, cURL accepts all protocols it was built with support for.
Available protocols are:
DICT , FILE , FTP , FTPS , GOPHER , GOPHERS , HTTP , HTTPS , IMAP , IMAPS , LDAP , LDAPS , MQTT , POP3 , POP3S , RTMP , RTMPE , RTMPS , RTMPT , RTMPTE , RTMPTS , RTSP , SCP , SFTP , SMB , SMBS , SMTP , SMTPS , TELNET , TFTP , WS , WSS .
Available as of PHP 8.3.0 and cURL 7.85.0.
|
CURLOPT_PROXY
(int)
|
A string with the HTTP proxy to tunnel requests through.
This should be the hostname, the dotted numerical IP address
or a numerical IPv6 address written within [brackets].
Available as of cURL 7.1.0.
|
CURLOPT_PROXYAUTH
(int)
|
A bitmask of the HTTP authentication method(s)
(CURLAUTH_* constants)
to use for the proxy connection.
For proxy authentication, only CURLAUTH_BASIC and
CURLAUTH_NTLM are currently supported.
Defaults to CURLAUTH_BASIC .
Available as of cURL 7.10.7.
|
An array of custom HTTP header strings to pass to proxies.
Available as of PHP 7.0.7 and cURL 7.37.0.
|
CURLOPT_PROXYPASSWORD
(int)
|
Set a string with the password to be used for authentication with the proxy.
Available as of cURL 7.19.1.
|
CURLOPT_PROXYPORT
(int)
|
An int with the port number of the proxy to connect to.
This port number can also be set in CURLOPT_PROXY .
Setting this to zero makes cURL use the default proxy port number
or the port number specified in the proxy URL string.
Available as of cURL 7.1.0.
|
CURLOPT_PROXYTYPE
(int)
|
Sets the type of the proxy to one of the
CURLPROXY_* constants.
Defaults to CURLPROXY_HTTP .
Available as of cURL 7.10.
|
CURLOPT_PROXYUSERNAME
(int)
|
Set a string with the username to be used for authentication with the proxy.
Available as of cURL 7.19.1.
|
CURLOPT_PROXYUSERPWD
(int)
|
A string with a username and password formatted as
[username]:[password] to use for the
connection to the proxy.
Available as of cURL 7.1.0.
|
CURLOPT_PROXY_CAINFO
(int)
|
The path to proxy Certificate Authority (CA) bundle. Set the path as a
string naming a file holding one or more certificates to
verify the HTTPS proxy with.
This option is for connecting to an HTTPS proxy, not an HTTPS server.
Defaults set to the system path where cURL's cacert bundle is assumed
to be stored.
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_CAINFO_BLOB
(int)
|
A string with the name of a PEM file holding one or more certificates to verify the HTTPS proxy with.
This option is for connecting to an HTTPS proxy, not an HTTPS server.
Defaults set to the system path where cURL's cacert bundle is assumed
to be stored.
Available as of PHP 8.2.0 and cURL 7.77.0.
|
CURLOPT_PROXY_CAPATH
(int)
|
A string with the directory holding multiple CA certificates
to verify the HTTPS proxy with.
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_CRLFILE
(int)
|
Set to a string with the file name
with the concatenation of CRL (Certificate Revocation List)
in PEM format to use in the certificate validation that occurs during
the SSL exchange.
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_ISSUERCERT
(int)
|
Proxy issuer SSL certificate filename string.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_PROXY_ISSUERCERT_BLOB
(int)
|
A string with the proxy issuer SSL certificate.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_PROXY_KEYPASSWD
(int)
|
Set the string be used as the password required to use the
CURLOPT_PROXY_SSLKEY private key.
A passphrase is not needed to load a certificate
but one is needed to load a private key.
This option is for connecting to an HTTPS proxy, not an HTTPS server.
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_PINNEDPUBLICKEY
(int)
|
Set the pinned public key for HTTPS proxy.
The string can be the file name of the pinned public key
which is expected to be in a PEM
or DER file format.
The string can also be any number of base64 encoded sha256 hashes
preceded by sha256// and separated by ; .
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_SERVICE_NAME
(int)
|
A string with the proxy authentication service name.
Available as of PHP 7.0.7, cURL 7.43.0 (for HTTP proxies) and cURL 7.49.0 (for SOCKS5 proxies).
|
CURLOPT_PROXY_SSLCERT
(int)
|
A string with the file name of the client certificate used to connect to the HTTPS proxy.
The default format is P12 on Secure Transport and PEM on other engines,
and can be changed with CURLOPT_PROXY_SSLCERTTYPE .
With NSS or Secure Transport, this can also be the nickname of the certificate
used for authentication as it is named in the security database.
If a file from the current directory is to be used,
it must be prefixed with ./
in order to avoid confusion with a nickname.
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_SSLCERTTYPE
(int)
|
A string with the format of the client certificate used when connecting to an HTTPS proxy.
Supported formats are PEM and DER , except with Secure Transport.
OpenSSL (versions 0.9.3 and later) and Secure Transport
(on iOS 5 or later, or OS X 10.7 or later) also support P12 for
PKCS#12-encoded files. Defaults to PEM .
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_SSLCERT_BLOB
(int)
|
A string with the SSL proxy client certificate.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_PROXY_SSLKEY
(int)
|
A string with the file name of the private key
used for connecting to the HTTPS proxy.
The default format is PEM and can be changed with
CURLOPT_PROXY_SSLKEYTYPE .
(iOS and Mac OS X only) This option is ignored if cURL was built against
Secure Transport. Available if built with TLS enabled.
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_SSLKEYTYPE
(int)
|
A string with the format of the private key.
Supported formats are:
PEM , DER , ENG .
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_SSLKEY_BLOB
(int)
|
A string with the private key for connecting to the HTTPS proxy.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_PROXY_SSLVERSION
(int)
|
Set the preferred HTTPS proxy TLS version to one of the
CURL_SSLVERSION_*
constants.
Defaults to CURL_SSLVERSION_DEFAULT .
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_SSL_CIPHER_LIST
(int)
|
A string with a colon-separated list of ciphers
to use for the connection to the HTTPS proxy.
When used with OpenSSL commas and spaces are also acceptable as separators,
and ! , - and +
can be used as operators.
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_SSL_OPTIONS
(int)
|
Set proxy SSL behavior options, which is a bitmask of the
CURLSSLOPT_* constants.
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_SSL_VERIFYHOST
(int)
|
设置为 2 以根据代理名称验证 HTTPS 代理的证书名称字段。设置为 0
时,无论证书中使用的名称如何,连接都会成功。谨慎使用该能力!在 cURL 7.28.0 及更早版本中将其设置为
1 作为调试选项。在 cURL 7.28.1 到 7.65.3 中设置为 1 ,则返回
CURLE_BAD_FUNCTION_ARGUMENT 。自 cURL 7.66.0 起,视 1 和
2 为相同的值。默认为 2 。在生产环境中,此选项的值应保持为
2 。从 PHP 7.3.0 和 cURL 7.52.0 开始可用。
|
CURLOPT_PROXY_SSL_VERIFYPEER
(int)
|
false 时阻止 CURL 验证对等证书(peer's certificate)。可以使用 CURLOPT_CAINFO
选项指定要验证的备用证书,或者使用 CURLOPT_CAPATH 选项指定证书目录。设置为 false
时,无论如何验证对等证书都会成功。默认为 true 。自 PHP 7.3.0 和 cURL 7.52.0 起可用。
|
CURLOPT_PROXY_TLS13_CIPHERS
(int)
|
A string with a colon-separated list of ciphers to use for the connection to the TLS 1.3 connection to a proxy.
This option is currently used only when cURL is built to use OpenSSL 1.1.1 or later.
When using a different SSL backend the TLS 1.3 cipher suites can be set
with the CURLOPT_PROXY_SSL_CIPHER_LIST option.
Available as of PHP 7.3.0 and cURL 7.61.0.
|
CURLOPT_PROXY_TLSAUTH_PASSWORD
(int)
|
A string with the password to use for the TLS authentication method specified with the
CURLOPT_PROXY_TLSAUTH_TYPE option. Requires that the
CURLOPT_PROXY_TLSAUTH_USERNAME option to also be set.
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_TLSAUTH_TYPE
(int)
|
The method of the TLS authentication used for the HTTPS connection.
Supported method is SRP .
注意:
Secure Remote Password (SRP) authentication for TLS provides mutual authentication
if both sides have a shared secret. To use TLS-SRP, the
CURLOPT_PROXY_TLSAUTH_USERNAME and
CURLOPT_PROXY_TLSAUTH_PASSWORD options must also be set.
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_TLSAUTH_USERNAME
(int)
|
The username to use for the HTTPS proxy TLS authentication method specified with the
CURLOPT_PROXY_TLSAUTH_TYPE option. Requires that the
CURLOPT_PROXY_TLSAUTH_PASSWORD option to also be set.
Available as of PHP 7.3.0 and cURL 7.52.0.
|
CURLOPT_PROXY_TRANSFER_MODE
(int)
|
Set to 1 to set the transfer mode (binary or ASCII)
for FTP transfers done via an HTTP proxy, by appending
type=a or type=i to the URL.
Without this setting or it being set to 0 ,
CURLOPT_TRANSFERTEXT has no effect
when doing FTP via a proxy.
Defaults to 0 .
Available as of cURL 7.18.0.
|
CURLOPT_PUT
(int)
|
true 时允许 HTTP 发送文件。要被 PUT 的文件必须在 CURLOPT_READDATA
和CURLOPT_INFILESIZE 中设置。自 cURL 7.1.0 起可用并于 cURL 7.12.1
弃用。
|
CURLOPT_QUICK_EXIT
(int)
|
Set to true for cURL to skip cleanup of resources
when recovering from a timeout.
This allows for a swift termination of the cURL process
at the expense of a possible leak of associated resources.
Available as of PHP 8.3.0 and cURL 7.87.0.
|
CURLOPT_QUOTE
(int)
|
An array of FTP command strings to execute on the server prior to the FTP request.
Available as of cURL 7.1.0.
|
CURLOPT_RANDOM_FILE
(int)
|
A string with a filename to be used to seed the random number generator for SSL.
Available as of cURL 7.7.0 and deprecated as of cURL 7.84.0.
|
CURLOPT_RANGE
(int)
|
A string with the range(s) of data to retrieve in the format X-Y where X or Y are optional. HTTP transfers
also support several intervals, separated with commas in the format
X-Y,N-M .
Set to null to disable requesting a byte range.
Available as of cURL 7.1.0.
|
CURLOPT_READDATA
(int)
|
Sets a file pointer resource that will be used by the file read function
set with CURLOPT_READFUNCTION .
Available as of cURL 7.9.7.
|
CURLOPT_READFUNCTION
(int)
|
A callable with the following signature:
curlHandle
-
The cURL handle.
streamResource
-
Stream resource provided to cURL through the option
CURLOPT_READDATA .
maxAmountOfDataToRead
-
The maximum amount of data to be read.
The callback should return a string
with a length equal or smaller than the amount of data requested,
typically by reading it from the passed stream resource. It should
return an empty string to signal EOF .
Available as of cURL 7.1.0.
|
CURLOPT_REDIR_PROTOCOLS
(int)
|
Bitmask of CURLPROTO_* values
which limit what protocols cURL may use in a transfer that it follows to in
a redirect when CURLOPT_FOLLOWLOCATION is enabled.
This allows limiting specific transfers to only be allowed to use a subset
of protocols in redirections.
As of cURL 7.19.4, by default cURL will allow all protocols
except for FILE and SCP .
Prior to cURL 7.19.4, cURL would unconditionally follow to all supported protocols.
See also CURLOPT_PROTOCOLS for protocol constant values.
Available as of cURL 7.19.4 and deprecated as of cURL 7.85.0.
|
CURLOPT_REDIR_PROTOCOLS_STR
(int)
|
Set to a string with a comma separated list
of case insensitive protocol names (URL schemes)
to allow to follow to in a redirect when
CURLOPT_FOLLOWLOCATION is enabled.
Set to ALL to enable all protocols.
As of cURL 7.65.2 it defaults to FTP ,
FTPS , HTTP and HTTPS .
From cURL 7.40.0 to 7.65.1, this defaults to all protocols except
FILE , SCP , SMB and
SMBS .
Prior to cURL 7.40.0, this defaults to all protocols except
FILE and SCP .
Available protocols are:
DICT , FILE , FTP , FTPS , GOPHER , GOPHERS , HTTP , HTTPS , IMAP , IMAPS , LDAP , LDAPS , MQTT , POP3 , POP3S , RTMP , RTMPE , RTMPS , RTMPT , RTMPTE , RTMPTS , RTSP , SCP , SFTP , SMB , SMBS , SMTP , SMTPS , TELNET , TFTP , WS , WSS .
Available as of PHP 8.3.0 and cURL 7.85.0.
|
CURLOPT_REFERER
(int)
|
A string with the contents of the Referer:
header to be used in a HTTP request.
Available as of cURL 7.1.0.
|
CURLOPT_REQUEST_TARGET
(int)
|
A string to use in the upcoming request
instead of the path as extracted from the URL.
Available as of PHP 7.3.0 and cURL 7.55.0.
|
CURLOPT_RESOLVE
(int)
|
Provide an array of colon-separated strings
with custom addresses for specific host and port pairs in the following format:
array(
"example.com:80:127.0.0.1",
"example2.com:443:127.0.0.2",
)
Available as of cURL 7.21.3.
|
CURLOPT_RESUME_FROM
(int)
|
恢复传输时,传递字节为单位的偏移量(以字节为单位)。此选项接受任何可以转换为有效 int
的值。自 cURL 7.1.0 起可用。
|
CURLOPT_RETURNTRANSFER
(int)
|
true 将 curl_exec() 获取的信息以 string 返回,而不是直接输出。
|
CURLOPT_RTSP_CLIENT_CSEQ
(int)
|
Set an int with the CSEQ number to issue for the next RTSP request.
Useful if the application is resuming a previously broken connection.
The CSEQ increments from this new number henceforth.
Defaults to 0 .
Available as of cURL 7.20.0.
|
CURLOPT_RTSP_REQUEST
(int)
|
Sets the kind of RTSP request to make.
Must be one of the CURL_RTSPREQ_*
constants.
Available as of cURL 7.20.0.
|
CURLOPT_RTSP_SERVER_CSEQ
(int)
|
Set an int with the CSEQ number to expect
for the next RTSP Server to Client request.
This feature (listening for Server requests) is unimplemented.
Defaults to 0 .
Available as of cURL 7.20.0.
|
CURLOPT_RTSP_SESSION_ID
(int)
|
Set a string with the value of the current RTSP Session ID for the handle.
Once this value is set to any non-null value,
cURL returns CURLE_RTSP_SESSION_ERROR
if the ID received from the server does not match.
If set to null , cURL automatically sets the ID
the first time the server sets it in a response.
Defaults to null
Available as of cURL 7.20.0.
|
CURLOPT_RTSP_STREAM_URI
(int)
|
Sets a string with the stream URI to operate on.
If not set, cURL defaults to operating on generic server options
by passing * in the place of the RTSP Stream URI.
When working with RTSP, CURLOPT_RTSP_STREAM_URI
indicates what URL to send to the server in the request header
while the CURLOPT_URL indicates
where to make the connection to.
Available as of cURL 7.20.0.
|
CURLOPT_RTSP_TRANSPORT
(int)
|
Set the Transport: header for this RTSP session.
Available as of cURL 7.20.0.
|
CURLOPT_SAFE_UPLOAD
(int)
|
始终为 true ,在 CURLOPT_POSTFIELDS 中禁用了对上传文件的 @
前缀的支持,这意味着以 @ 开头的值可以作为字段安全地传递。上传可使用 CURLFile 替代。
|
CURLOPT_SASL_AUTHZID
(int)
|
The authorization identity (authzid) string for the transfer. Only applicable to the PLAIN SASL
authentication mechanism where it is optional. When not specified, only the authentication identity
(authcid) as specified by the username will be sent to the server, along with the password.
The server will derive the authzid from the authcid when not provided, which it will then use internally.
Available as of PHP 8.2.0 and cURL 7.66.0.
|
CURLOPT_SASL_IR
(int)
|
true 时开启,收到首包(first packet)后发送初始的响应(initial response)。自 PHP 7.0.7 和 cURL 7.31.0 起可用。
|
CURLOPT_SERVICE_NAME
(int)
|
A string with the authentication service name.
Available as of PHP 7.0.7 and cURL 7.43.0.
|
CURLOPT_SHARE
(int)
|
curl_share_init() 的结果。使 cURL 可以使用共享句柄中的数据。自 cURL 7.10 起可用。
|
CURLOPT_SOCKS5_AUTH
(int)
|
用于 SOCKS5 验证方法。选项是:
CURLAUTH_BASIC , CURLAUTH_GSSAPI , CURLAUTH_NONE 。当设置了多种方法时,cURL 将轮询服务器以查看其支持哪些方法并选择最佳方法。默认为
CURLAUTH_BASIC|CURLAUTH_GSSAPI 。使用 CURLOPT_PROXYUSERPWD
选项设置真实的用户名和密码。自 PHP 7.3.0 和 cURL 7.55.0 起可用。
|
CURLOPT_SOCKS5_GSSAPI_NEC
(int)
|
Set to 1 to enable and 0 to disable
the unprotected exchange of the protection mode negotiation
as part of the GSSAPI negotiation.
Available as of cURL 7.19.4.
|
CURLOPT_SOCKS5_GSSAPI_SERVICE
(int)
|
Set a string holding the name of the SOCKS5 service.
Defaults to rcmd .
Available as of cURL 7.19.4 and deprecated as of cURL 7.49.0.
Use CURLOPT_PROXY_SERVICE_NAME instead.
|
CURLOPT_SSH_AUTH_TYPES
(int)
|
A bitmask consisting of one or more of the following constants:
CURLSSH_AUTH_PUBLICKEY , CURLSSH_AUTH_PASSWORD , CURLSSH_AUTH_HOST , CURLSSH_AUTH_KEYBOARD , CURLSSH_AUTH_AGENT , CURLSSH_AUTH_ANY .
Defaults to CURLSSH_AUTH_ANY .
Available as of cURL 7.16.1.
|
CURLOPT_SSH_COMPRESSION
(int)
|
true to enable, false to disable built-in SSH compression.
Note that the server can disregard this request.
Defaults to false .
Available as of PHP 7.3.0 and cURL 7.56.0.
|
CURLOPT_SSH_HOSTKEYFUNCTION
(int)
|
A callable that will be called when SSH host key verification is needed.
The callback must have the following signature:
curlHandle
-
The cURL handle.
keyType
-
One of the
CURLKHTYPE_* key types.
key
-
The key to check.
keyLength
-
The length of the key in bytes.
This callback overrides CURLOPT_SSH_KNOWNHOSTS .
Available as of PHP 8.3.0 and cURL 7.84.0.
|
CURLOPT_SSH_HOST_PUBLIC_KEY_MD5
(int)
|
A string containing 32 hexadecimal digits which should contain the
MD5 checksum of the remote host's public key, and cURL will reject
the connection to the host unless the md5sums match.
This option is only for SCP and SFTP transfers.
Available as of cURL 7.17.1.
|
CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256
(int)
|
A string with the base64-encoded SHA256 hash
of the remote host's public key.
The transfer will fail if the given hash does not match the hash the remote host provides.
Available as of PHP 8.2.0 and cURL 7.80.0.
|
CURLOPT_SSH_KNOWNHOSTS
(int)
|
Set to the filename of the known_host file to use
which should use the OpenSSH file format as supported by libssh2.
Available as of cURL 7.19.6.
|
CURLOPT_SSH_PRIVATE_KEYFILE
(int)
|
The file name for a private key. If not used, cURL defaults to
$HOME/.ssh/id_dsa if the HOME environment variable is set,
and just id_dsa in the current directory if HOME is not set.
If the file is password-protected, set the password with
CURLOPT_KEYPASSWD .
Available as of cURL 7.16.1.
|
CURLOPT_SSH_PUBLIC_KEYFILE
(int)
|
The file name for a public key. If not used, cURL defaults to
$HOME/.ssh/id_dsa.pub if the HOME environment variable is set,
and just id_dsa.pub in the current directory if HOME is not set.
Available as of cURL 7.16.1.
|
CURLOPT_SSLCERT
(int)
|
The name of a file containing a PEM formatted certificate.
Available as of cURL 7.1.0.
|
CURLOPT_SSLCERTPASSWD
(int)
|
The password required to use the
CURLOPT_SSLCERT certificate.
Available as of cURL 7.1.0 and deprecated as of cURL 7.17.0.
|
CURLOPT_SSLCERTTYPE
(int)
|
A string with the format of the certificate. Supported formats are:
PEM , DER , ENG , P12 .
P12 (for PKCS#12-encoded files) is available as of OpenSSL 0.9.3.
Defaults to PEM .
Available as of cURL 7.9.3.
|
CURLOPT_SSLCERT_BLOB
(int)
|
A string with the SSL client certificate.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_SSLENGINE
(int)
|
The string identifier for the crypto engine of the private SSL key
specified in CURLOPT_SSLKEY .
Available as of cURL 7.9.3.
|
CURLOPT_SSLENGINE_DEFAULT
(int)
|
The string identifier for the crypto engine used for asymmetric crypto
operations.
Available as of cURL 7.9.3.
|
CURLOPT_SSLKEY
(int)
|
The name of a file containing a private SSL key.
Available as of cURL 7.9.3.
|
CURLOPT_SSLKEYPASSWD
(int)
|
The secret password needed to use the private SSL key specified in
CURLOPT_SSLKEY .
注意:
Since this option contains a sensitive password, remember to keep
the PHP script it is contained within safe.
Available as of cURL 7.9.3 and deprecated as of cURL 7.17.0.
|
CURLOPT_SSLKEYTYPE
(int)
|
The key type of the private SSL key specified in
CURLOPT_SSLKEY . Supported key types are:
PEM , DER , ENG .
Defaults to PEM .
Available as of cURL 7.9.3.
|
CURLOPT_SSLKEY_BLOB
(int)
|
A string private key for client cert.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_SSLVERSION
(int)
|
One of
the CURL_SSLVERSION_* constants.
Defaults to CURL_SSLVERSION_DEFAULT .
Available as of cURL 7.1.0.
|
CURLOPT_SSL_CIPHER_LIST
(int)
|
A colon-separated string of ciphers to use
for the TLS 1.2 (1.1, 1.0) connection.
Available as of cURL 7.9.
|
CURLOPT_SSL_EC_CURVES
(int)
|
A colon delimited list of elliptic curve algorithms. For example,
X25519:P-521 is a valid list of two elliptic curves.
This option defines the client's key exchange algorithms in the SSL handshake,
if the SSL backend cURL is built to use supports it.
Available as of PHP 8.2.0 and cURL 7.73.0.
|
CURLOPT_SSL_ENABLE_ALPN
(int)
|
false 时禁用 SSL 握手中的 ALPN(如果 SSL 后端的
cURL 内建支持)用于协商到 http2。自 PHP 7.0.7 和 cURL 7.36.0 起可用。
|
CURLOPT_SSL_ENABLE_NPN
(int)
|
false 时禁用 SSL 握手中的 NPN(如果 SSL 后端的 libcurl 内建支持),用于协商到
http2。自 PHP 7.0.7 和 cURL 7.36.0 起可用,并且自 cURL 7.86.0 起弃用。
|
CURLOPT_SSL_FALSESTART
(int)
|
true 表示启用,false 表示禁用 TLS 错误启动,这是 TLS 客户端在验证服务器 Finished
消息之前开始发送应用程序数据的模式。自 PHP 7.0.7 和 cURL 7.42.0 起可用。
|
CURLOPT_SSL_OPTIONS
(int)
|
Set SSL behavior options, which is a bitmask of the
CURLSSLOPT_* constants.
Defaults to none of the bits being set.
Available as of PHP 7.0.7. and cURL 7.25.0.
|
CURLOPT_SSL_SESSIONID_CACHE
(int)
|
Set to 0 to disable and 1 to enable
SSL session-ID caching.
By default all transfers are done using the cache enabled.
Available as of cURL 7.16.0.
|
CURLOPT_SSL_VERIFYHOST
(int)
|
2 时验证 SSL 对等证书中的公用名称字段或主题备用名称(Subject Alternate Name,简称
SNA)字段是否与提供的主机名匹配。0 时不检查名称。不应使用 1 。在生产环境中,此选项的值应保持为
2 (默认值)。自 cURL 7.8.1 起可用。
|
CURLOPT_SSL_VERIFYPEER
(int)
|
false 时禁止 cURL 验证对等证书(peer's certificate)。要验证的交换证书可以在 CURLOPT_CAINFO
选项中设置,或在 CURLOPT_CAPATH 中设置证书目录。自 cURL 7.10 起默认为 true 。自 cURL 7.10
起安装默认的 CA 证书包。自 cURL 7.4.2 起可用。
|
CURLOPT_SSL_VERIFYSTATUS
(int)
|
true 时启用或者 false 时禁用验证证书状态。自 PHP 7.0.7 和 cURL 7.41.0 起可用。
|
CURLOPT_STDERR
(int)
|
Accepts a file handle resource pointing to
an alternative location to output errors to instead of
STDERR .
Available as of cURL 7.1.0.
|
CURLOPT_STREAM_WEIGHT
(int)
|
设置 stream weight 数值(1 和 256 之间的数字)。自 PHP 7.0.7 和 cURL 7.46.0 起可用。
|
true to suppress proxy CONNECT response headers from the user callback functions
CURLOPT_HEADERFUNCTION and CURLOPT_WRITEFUNCTION ,
when CURLOPT_HTTPPROXYTUNNEL is used and a CONNECT request is made.
Defaults to false .
Available as of PHP 7.3.0 and cURL 7.54.0.
|
CURLOPT_TCP_FASTOPEN
(int)
|
true 时启用或者 false 时禁用 TCP Fast Open。自 PHP 7.0.7 和 cURL 7.49.0 起可用。
|
CURLOPT_TCP_KEEPALIVE
(int)
|
如果设置为 1 ,将发送 TCP keepalive 探针。这些探针的延迟和频率可以通过 CURLOPT_TCP_KEEPIDLE
和 CURLOPT_TCP_KEEPINTVL 选项来控制,前提是操作系统支持它们。如果设置为 0 (默认值),将禁用
keepalive 探针。
The maximum number of probes can be set with the CURLOPT_TCP_KEEPCNT
option.
Available as of cURL 7.25.0.
|
CURLOPT_TCP_KEEPIDLE
(int)
|
设置延迟秒数,如果启用了 CURLOPT_TCP_KEEPALIVE ,操作系统将在连接空闲时等待,然后再发送
keepalive 探针。并非所有操作系统都支持此选项。默认值为 60 。自 cURL 7.25.0 起可用。
|
CURLOPT_TCP_KEEPINTVL
(int)
|
设置间隔(以秒为单位),如果启用了 CURLOPT_TCP_KEEPALIVE ,操作系统将在发送
keepalive 探针之间等待。并非所有操作系统都支持此选项。默认值为 60 。自 cURL 7.25.0 起可用。
|
CURLOPT_TCP_KEEPCNT
(int)
|
Sets the maximum number of TCP keep-alive probes.
The default is 9 .
Available as of PHP 8.4.0 and cURL 8.9.0.
|
CURLOPT_TCP_NODELAY
(int)
|
true 时禁用 TCP 的 Nagle 算法,就是减少网络上的小数据包数量。默认是 true 。自 cURL 7.11.2 起可用。
|
CURLOPT_TELNETOPTIONS
(int)
|
Set an array of strings to pass to the telnet negotiations.
The variables should be in the format >option=value< .
cURL supports the options TTYPE ,
XDISPLOC and NEW_ENV .
Available as of cURL 7.7.0.
|
CURLOPT_TFTP_BLKSIZE
(int)
|
Set the blocksize to use for TFTP data transmission.
Valid range is 8 -65464 bytes.
The default of 512 bytes is used if this option is not specified.
The specified block size is only used if supported by the remote server.
If the server does not return an option acknowledgment
or returns an option acknowledgment with no block size,
the default of 512 bytes is used.
Available as of cURL 7.19.4.
|
CURLOPT_TFTP_NO_OPTIONS
(int)
|
true 时不发送 TFTP 的 options 请求。默认为 false 。自 PHP 7.0.7 和 cURL 7.48.0 起可用。
|
CURLOPT_TIMECONDITION
(int)
|
设置如何对待 CURLOPT_TIMEVALUE 。使用 CURL_TIMECOND_IFMODSINCE ,仅在页面
CURLOPT_TIMEVALUE 之后修改,才返回页面。没有修改则返回 304 Not Modified
header,假设设置了 CURLOPT_HEADER 为 true 。CURL_TIMECOND_IFUNMODSINCE
则起相反的效果。使用 CURL_TIMECOND_NONE 忽略 CURLOPT_TIMEVALUE 并始终返回页面。默认为
CURL_TIMECOND_IFMODSINCE 。在 cURL 7.46.0 之前,默认值为 CURL_TIMECOND_IFMODSINCE 。自
cURL 7.1.0 起可用。
|
CURLOPT_TIMEOUT
(int)
|
允许 cURL 函数执行的最长秒数。
Defaults to 0 , meaning that functions never time out during transfer.
Available as of cURL 7.1.0.
|
CURLOPT_TIMEOUT_MS
(int)
|
允许 cURL 允许执行的最长毫秒数。如果 cURL 编译时使用系统标准的名称解析器( standard system name
resolver),那部分的连接仍旧使用以秒计的超时解决方案,最小超时时间还是一秒钟。
Defaults to 0 , meaning that functions never time out during transfer.
Available as of cURL 7.16.2.
|
CURLOPT_TIMEVALUE
(int)
|
秒数,从 1970 年 1 月 1 日开始。这个时间将由 CURLOPT_TIMECONDITION 使用。默认
0 。自 cURL 7.1.0 起可用。
|
CURLOPT_TIMEVALUE_LARGE
(int)
|
The time in seconds since January 1st, 1970. The time will be used
by CURLOPT_TIMECONDITION . Defaults to zero.
The difference between this option and CURLOPT_TIMEVALUE
is the type of the argument. On systems where 'long' is only 32 bit wide,
this option has to be used to set dates beyond the year 2038.
Available as of PHP 7.3.0 and cURL 7.59.0.
|
CURLOPT_TLS13_CIPHERS
(int)
|
A string with a colon-separated list of ciphers
to use for the connection to the TLS 1.3 connection.
This option is currently used only when cURL is built to use OpenSSL 1.1.1 or later.
When using a different SSL backend the TLS 1.3 cipher suites can be set
with the CURLOPT_SSL_CIPHER_LIST option.
Available as of PHP 7.3.0 and cURL 7.61.0.
|
CURLOPT_TLSAUTH_PASSWORD
(int)
|
Set a password to use for the TLS authentication method specified
with the CURLOPT_TLSAUTH_TYPE option. Requires that
the CURLOPT_TLSAUTH_USERNAME option also be set.
This feature relies on TLS SRP which does not work with TLS 1.3.
Available as of cURL 7.21.4.
|
CURLOPT_TLSAUTH_TYPE
(int)
|
Set a string with the method of the TLS authentication.
Supported method is SRP
(TLS Secure Remote Password authentication).
Available as of cURL 7.21.4.
|
CURLOPT_TLSAUTH_USERNAME
(int)
|
Set a string with the username to use for the TLS authentication method
specified with the CURLOPT_TLSAUTH_TYPE option.
Requires that the CURLOPT_TLSAUTH_PASSWORD option
also be set.
This feature relies on TLS SRP which does not work with TLS 1.3.
Available as of cURL 7.21.4.
|
CURLOPT_TRANSFER_ENCODING
(int)
|
Set to 1 to enable and 0 to disable
requesting compressed Transfer Encoding in the outgoing
HTTP request. If the server responds with a compressed
Transfer Encoding ,
cURL will automatically uncompress it on reception.
Defaults to 0 .
Available as of cURL 7.21.6.
|
CURLOPT_TRANSFERTEXT
(int)
|
true 时 FTP 传输使用 ASCII 模式。对于 LDAP,会检索纯文本信息而非 HTML。在 Windows 系统上,系统不会把
STDOUT 设置成二进制模式。默认是 false 。自 cURL 7.1.1 起可用。
|
CURLOPT_UNIX_SOCKET_PATH
(int)
|
Enables the use of Unix domain sockets as connection endpoint and
sets the path to the given string.
Set to null to disable.
Defaults to null .
Available as of PHP 7.0.7 and cURL 7.40.0.
|
CURLOPT_UNRESTRICTED_AUTH
(int)
|
true 时在使用 CURLOPT_FOLLOWLOCATION 重定向 header 中的多个 location
时继续发送用户名和密码信息,哪怕主机名已改变。默认为 false 。自 cURL 7.10.4 起可用。
|
CURLOPT_UPKEEP_INTERVAL_MS
(int)
|
Some protocols have "connection upkeep" mechanisms. These mechanisms usually send some traffic
on existing connections in order to keep them alive. This option defines the connection upkeep interval.
Currently, the only protocol with a connection upkeep mechanism is HTTP/2. When the connection upkeep
interval is exceeded, an HTTP/2 PING frame is sent on the connection.
Defaults to CURL_UPKEEP_INTERVAL_DEFAULT
which is currently 60 seconds.
Available as of PHP 8.2.0 and cURL 7.62.0.
|
CURLOPT_UPLOAD
(int)
|
true 时准备执行上传。默认 false 。自 cURL 7.1.0 起可用。
|
CURLOPT_UPLOAD_BUFFERSIZE
(int)
|
Preferred buffer size in bytes for the cURL upload buffer.
The upload buffer size by default is 64 kilobytes. The maximum buffer size allowed to be set is 2 megabytes.
The minimum buffer size allowed to be set is 16 kilobytes.
Available as of PHP 8.2.0 and cURL 7.62.0.
|
CURLOPT_URL
(int)
|
The URL to fetch. This can also be set when initializing a
session with curl_init().
Available as of cURL 7.1.0.
|
CURLOPT_USE_SSL
(int)
|
Sets the desired level of SSL/TLS for the transfer
when using FTP, SMTP, POP3, IMAP, etc.
These are all protocols that start out plain text
and get "upgraded" to SSL using the STARTTLS command.
Set to one of the
CURLUSESSL_* constants.
Available as of cURL 7.17.0.
|
CURLOPT_USERAGENT
(int)
|
The contents of the User-Agent: header to be
used in a HTTP request.
Available as of cURL 7.1.0.
|
CURLOPT_USERNAME
(int)
|
The user name to use in authentication.
Available as of cURL 7.19.1.
|
CURLOPT_USERPWD
(int)
|
A username and password formatted as
[username]:[password] to use for the
connection.
Available as cURL 7.1.0.
|
CURLOPT_VERBOSE
(int)
|
true 时输出所有的信息,写入到 STDERR ,或在 CURLOPT_STDERR
中指定的文件。默认 false 。自 cURL 7.1.0 起可用。
|
CURLOPT_WILDCARDMATCH
(int)
|
Set to 1 to transfer multiple files
according to a filename pattern.
The pattern can be specified as part of the
CURLOPT_URL option,
using an fnmatch-like pattern (Shell Pattern Matching)
in the last part of URL (filename).
Available as of cURL 7.21.0.
|
CURLOPT_WRITEFUNCTION
(int)
|
A callable with the following signature:
curlHandle
-
The cURL handle.
data
-
The data to be written.
The data must be saved by the callback
and the callback must return the exact number of bytes written
or the transfer will be aborted with an error.
Available as of cURL 7.1.0.
|
接受文件句柄 resource,将传输的 header 部分写入该文件。自 cURL 7.1.0 起可用。
|
CURLOPT_WS_OPTIONS
(int)
|
Accepts a bitmask setting WebSocket behavior options.
The only available option is CURLWS_RAW_MODE .
Defaults to 0 .
Available as of PHP 8.3.0 and cURL 7.86.0.
|
CURLOPT_XFERINFOFUNCTION
(int)
|
A callable with the following signature:
callback( resource $curlHandle , int $bytesToDownload , int $bytesDownloaded , int $bytesToUpload , int $bytesUploaded ): int
curlHandle
-
The cURL handle.
bytesToDownload
-
The total number of bytes expected to be downloaded in this transfer.
bytesDownloaded
-
The number of bytes downloaded so far.
bytesToUpload
-
The total number of bytes expected to be uploaded in this transfer.
bytesUploaded
-
The number of bytes uploaded so far.
Return 1 to abort the transfer
and set a CURLE_ABORTED_BY_CALLBACK error.
Available as of PHP 8.2.0 and cURL 7.32.0.
|
CURLOPT_SERVER_RESPONSE_TIMEOUT
(int)
|
A timeout in seconds cURL will wait for a response from an
FTP, SFTP, IMAP,
SCP, SMTP, or a POP3 server.
This option replaces the existing CURLOPT_FTP_RESPONSE_TIMEOUT
option which is deprecated in cURL 7.85.0.
Available as of PHP 8.4.0.
|
CURLOPT_XOAUTH2_BEARER
(int)
|
Specifies the OAuth 2.0 access token.
Set to null to disable.
Defaults to null .
Available as of PHP 7.0.7 and cURL 7.33.0.
|
CURLOPT_PREREQFUNCTION
(int)
|
A callable with the following signature that gets called after the
connection is established, but before the request payload (for example, the
GET/POST/DELETE request of an HTTP connection) is sent, and can be used to abort
or allow the connection depending on the source and destination IP address and
port numbers:
curlHandle
-
The cURL handle.
destination_ip
-
The primary IP of the remote server established with this connection.
For FTP, this is the IP for the control connection.
IPv6 addresses are represented without surrounding brackets.
local_ip
-
The originating IP for this connection.
IPv6 addresses are represented without surrounding brackets.
destination_port
-
The primary port number on the remote server established with this connection.
For FTP, this is the port for the control connection.
This can be a TCP or a UDP port number depending on the protocol.
local_port
-
The originating port number for this connection.
This can be a TCP or a UDP port number depending on the protocol.
Return CURL_PREREQFUNC_OK to allow the request, or
CURL_PREREQFUNC_ABORT to abort the transfer.
Available as of PHP 8.4.0 and cURL 7.80.0.
|
CURLOPT_DEBUGFUNCTION
(int)
|
Available as of PHP 8.4.0.
This option requires CURLOPT_VERBOSE option enabled.
A callable to replace the standard cURL verbose output.
This callback gets called during various stages of the request with verbose debug information.
The callback should match the following signature:
curlHandle
-
The cURL handle.
type
-
One of the following constants indicating the type of the
data value:
data
-
Verbose debug data of the type indicate by the
type parameter.
|