(PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8)
curl_setopt — 设置 cURL 传输选项
handle
由 curl_init() 返回的 cURL 句柄。
option
需要设置的CURLOPT_XXX
选项。
value
将设置在option
选项上的值。
以下 option
参数的 value
应该被设置成 bool 类型:
选项 | 将 value 设置为 |
备注 |
---|---|---|
CURLOPT_AUTOREFERER |
true 时将根据 Location: 重定向时,自动设置 header 中的Referer: 信息。
|
|
CURLOPT_COOKIESESSION |
设为 true 时将开启新的一次 cookie 会话。它将强制 libcurl 忽略之前会话时存的其他 cookie。
libcurl 在默认状况下无论是否为会话,都会储存、加载所有 cookie。会话 cookie 是指没有过期时间,只存活在会话之中。
|
|
CURLOPT_CERTINFO |
true 将在安全传输时输出 SSL 证书信息到 STDERR 。
|
在 cURL 7.19.1 中添加。
需要开启 CURLOPT_VERBOSE 才有效。
|
CURLOPT_CONNECT_ONLY |
true 将让库执行所有需要的代理、验证、连接过程,但不传输数据。此选项用于
HTTP、SMTP 和 POP3。
|
在 7.15.2 中添加。 |
CURLOPT_CRLF |
启用时将Unix的换行符转换成回车换行符。 | |
CURLOPT_DNS_USE_GLOBAL_CACHE |
true 会启用一个全局的DNS缓存。此选项非线程安全的,默认已开启。
|
|
CURLOPT_FAILONERROR |
当 HTTP 状态码大于等于 400,true 将将显示错误详情。 默认情况下将返回页面,忽略 HTTP 代码。
|
|
CURLOPT_SSL_FALSESTART |
true 开启 TLS False Start (一种 TLS 握手优化方式)
|
cURL 7.42.0 中添加。自 PHP 7.0.7 起有效。 |
CURLOPT_FILETIME |
true 时,会尝试获取远程文档中的修改时间信息。
信息可通过curl_getinfo()函数的CURLINFO_FILETIME 选项获取。
|
|
CURLOPT_FOLLOWLOCATION |
true 时将会根据服务器返回 HTTP 头中的 "Location: " 重定向。参阅 CURLOPT_MAXREDIRS 。
|
|
CURLOPT_FORBID_REUSE |
true 在完成交互以后强制明确的断开连接,不能在连接池中重用。
|
|
CURLOPT_FRESH_CONNECT |
true 强制获取一个新的连接,而不是缓存中的连接。
|
|
CURLOPT_FTP_USE_EPRT |
true 时,当 FTP 下载时,使用 EPRT (和 LPRT)命令。 设置为 false 时禁用 EPRT 和 LPRT,仅仅使用PORT 命令。
|
|
CURLOPT_FTP_USE_EPSV |
true 时,在FTP传输过程中,回到 PASV 模式前,先尝试 EPSV 命令。设置为 false 时禁用 EPSV。
|
|
CURLOPT_FTP_CREATE_MISSING_DIRS |
true 时,当 ftp 操作不存在的目录时将创建它。
|
|
CURLOPT_FTPAPPEND |
true 为追加写入文件,而不是覆盖。
|
|
CURLOPT_TCP_NODELAY |
true 时禁用 TCP 的 Nagle 算法,就是减少网络上的小数据包数量。
|
编译的版本在 libcurl 7.11.2 及以上时有效。 |
CURLOPT_FTPASCII |
CURLOPT_TRANSFERTEXT 的别名。
|
|
CURLOPT_FTPLISTONLY |
true 时只列出 FTP 目录的名字。
|
|
CURLOPT_HEADER |
启用时会将头文件的信息作为数据流输出。 | |
CURLINFO_HEADER_OUT |
true 时追踪句柄的请求字符串。
|
CURLINFO_ 的前缀是指向的(intentional)。
|
CURLOPT_HTTP09_ALLOWED |
是否允许 HTTP/0.9 响应。从 libcurl 7.66.0 开始默认为 false ;以前默认为 true 。
|
如果编译的 libcurl 版本 >= 7.64.0,则分别从 PHP 7.3.15 和 7.4.3 开始可用 |
CURLOPT_HTTPGET |
true 时会设置 HTTP 的 method 为 GET,由于默认是 GET,所以只有 method 被修改时才需要这个选项。
|
|
CURLOPT_HTTPPROXYTUNNEL |
true 会通过指定的 HTTP 代理来传输。
|
|
CURLOPT_HTTP_CONTENT_DECODING |
false 时获取原始 HTTP 响应主体。
|
如果编译的 libcurl >= 7.16.2 时可用。 |
CURLOPT_KEEP_SENDING_ON_ERROR |
true 时,如果返回的 HTTP 代码等于或大于 300,则继续发送请求主体。默认操作是停止发送并关闭流或连接。适用于手动 NTLM 身份验证。大多数应用程序不需要此选项。
|
如果编译的 libcurl >= 7.51.0,则从 PHP 7.3.0 开始可用。 |
CURLOPT_MUTE |
true 时将完全静默,无论是何 cURL 函数。
|
在 cURL 7.15.5 中移出(可以使用 CURLOPT_RETURNTRANSFER 作为代替) |
CURLOPT_NETRC |
true 时,在连接建立时,访问~/.netrc文件获取用户名和密码来连接远程站点。
|
|
CURLOPT_NOBODY |
true 时将不输出 BODY 部分。同时 Mehtod 变成了 HEAD。修改为 false 时不会变成 GET。
|
|
CURLOPT_NOPROGRESS |
|
|
CURLOPT_NOSIGNAL |
true 时忽略所有的 cURL 传递给 PHP 进程的信号。在 SAPI 多线程传输时此项被默认启用,所以超时选项仍能使用。
|
cURL 7.10时被加入。 |
CURLOPT_PATH_AS_IS |
true 不处理 dot dot sequences (即 ../ )
|
cURL 7.42.0 时被加入。 PHP 7.0.7 起有效。 |
CURLOPT_PIPEWAIT |
true 则等待 pipelining/multiplexing。
|
cURL 7.43.0 时被加入。 PHP 7.0.7 起有效。 |
CURLOPT_POST |
true 时会发送 POST 请求,类型为:application/x-www-form-urlencoded ,是 HTML 表单提交时最常见的一种。
|
|
CURLOPT_PUT |
true 时允许 HTTP 发送文件。要被 PUT 的文件必须在 CURLOPT_INFILE 和CURLOPT_INFILESIZE 中设置。
|
|
CURLOPT_RETURNTRANSFER |
true 将curl_exec()获取的信息以字符串返回,而不是直接输出。
|
|
CURLOPT_SASL_IR |
true 开启,收到首包(first packet)后发送初始的响应(initial response)。
|
cURL 7.31.10 中添加,自 PHP 7.0.7 起有效。 |
CURLOPT_SSL_ENABLE_ALPN |
false 禁用 SSL 握手中的 ALPN (如果 SSL 后端的
libcurl 内建支持) 用于协商到 http2。
|
cURL 7.36.0 中增加, PHP 7.0.7 起有效。 |
CURLOPT_SSL_ENABLE_NPN |
false 禁用 SSL 握手中的 NPN(如果 SSL 后端的
libcurl 内建支持),用于协商到 http2。
|
cURL 7.36.0 中增加, PHP 7.0.7 起有效。 |
CURLOPT_SSL_VERIFYPEER |
false 禁止 cURL 验证对等证书(peer's
certificate)。要验证的交换证书可以在 CURLOPT_CAINFO 选项中设置,或在 CURLOPT_CAPATH 中设置证书目录。
|
自cURL 7.10开始默认为 true 。从 cURL 7.10开始默认绑定安装。
|
CURLOPT_SSL_VERIFYSTATUS |
true 验证证书状态。
|
cURL 7.41.0 中添加, PHP 7.0.7 起有效。 |
CURLOPT_PROXY_SSL_VERIFYPEER |
false 会阻止 CURL 验证对等证书(peer's certificate)。可以使用 CURLOPT_CAINFO
选项指定要验证的备用证书,或者可以使用 CURLOPT_CAPATH 选项指定证书目录。设置为
false 时,无论如何验证对等证书都会成功。
|
默认为 true 。自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。
|
CURLOPT_SAFE_UPLOAD |
始终为 true ,在 CURLOPT_POSTFIELDS 中禁用了对上传文件的 @
前缀的支持,这意味着以 @ 开头的值可以作为字段安全地传递。上传可使用 CURLFile 替代。
|
|
CURLOPT_TCP_FASTOPEN |
true 开启 TCP Fast Open。
|
cURL 7.49.0 中添加, PHP 7.0.7 起有效。 |
CURLOPT_TFTP_NO_OPTIONS |
true 不发送 TFTP 的 options 请求。
|
自 cURL 7.48.0 添加, PHP 7.0.7 起有效。 |
CURLOPT_TRANSFERTEXT |
true 对 FTP 传输使用 ASCII 模式。对于LDAP,它检索纯文本信息而非 HTML。在 Windows 系统上,系统不会把 STDOUT 设置成二进制 模式。
|
|
CURLOPT_UNRESTRICTED_AUTH |
true 在使用CURLOPT_FOLLOWLOCATION 重定向 header 中的多个 location 时继续发送用户名和密码信息,哪怕主机名已改变。
|
|
CURLOPT_UPLOAD |
true 准备上传。
|
|
CURLOPT_VERBOSE |
true 会输出所有的信息,写入到STDERR ,或在CURLOPT_STDERR 中指定的文件。
|
以下 option
的 value
应该被设置成 int:
选项 | 设置 value 为 |
备注 | |
---|---|---|---|
CURLOPT_BUFFERSIZE |
每次读入的缓冲的尺寸。当然不保证每次都会完全填满这个尺寸。 | 在cURL 7.10中被加入。 | |
CURLOPT_CONNECTTIMEOUT |
在尝试连接时等待的秒数。设置为0,则无限等待。 | ||
CURLOPT_CONNECTTIMEOUT_MS |
尝试连接等待的时间,以毫秒为单位。设置为0,则无限等待。 如果 libcurl 编译时使用系统标准的名称解析器( standard system name resolver),那部分的连接仍旧使用以秒计的超时解决方案,最小超时时间还是一秒钟。 | 在 cURL 7.16.2 中被加入。 | |
CURLOPT_DNS_CACHE_TIMEOUT |
设置在内存中缓存 DNS 的时间,默认为120秒(两分钟)。 | ||
CURLOPT_EXPECT_100_TIMEOUT_MS |
Expect: 100-continue 响应的超时时间,以毫秒为单位。
默认为 1000 毫秒。
|
cURL 7.36.0 中添加,自 PHP 7.0.7 有效。 | |
CURLOPT_FTPSSLAUTH |
FTP验证方式(启用的时候):CURLFTPAUTH_SSL (首先尝试SSL),CURLFTPAUTH_TLS (首先尝试TLS)或CURLFTPAUTH_DEFAULT (让cURL 自个儿决定)。
|
在 cURL 7.12.2 中被加入。 | |
CURLOPT_HEADEROPT |
如何处理 header。以下常量中的某个:
CURLHEADER_SEPARATE ,之前默认是 CURLHEADER_UNIFIED 。
|
Added in cURL 7.37.0. Available since PHP 7.0.7. | |
CURLOPT_HTTP_VERSION |
CURL_HTTP_VERSION_NONE (默认值,让 cURL 自己判断使用哪个版本),CURL_HTTP_VERSION_1_0 (强制使用 HTTP/1.0)或CURL_HTTP_VERSION_1_1 (强制使用 HTTP/1.1)。
|
||
CURLOPT_HTTPAUTH |
使用的 HTTP 验证方法。选项有:
可以使用
|
||
CURLOPT_INFILESIZE |
希望传给远程站点的文件尺寸,字节(byte)为单位。
注意无法用这个选项阻止 libcurl 发送更多的数据,确切发送什么取决于 CURLOPT_READFUNCTION 。
|
||
CURLOPT_LOW_SPEED_LIMIT |
传输速度,每秒字节(bytes)数,根据CURLOPT_LOW_SPEED_TIME 秒数统计是否因太慢而取消传输。
|
||
CURLOPT_LOW_SPEED_TIME |
当传输速度小于CURLOPT_LOW_SPEED_LIMIT 时(bytes/sec),PHP会判断是否因太慢而取消传输。
|
||
CURLOPT_MAIL_RCPT_ALLLOWFAILS |
允许一些收件人的 RCPT TO 命令失败。 | 在向多个收件人发送数据时,如果至少有一个收件人导致 RCPT TO 命令返回错误,默认情况下 cURL 将中止 SMTP 对话。此选项告诉 cURL 忽略错误并继续使用剩余的有效收件人。如果所有收件人触发 RCPT TO 失败并且设置了此 flag,cURL 将中止 SMTP 对话并返回从最后一个 RCPT TO 命令收到的错误。 | |
CURLOPT_MAXAGE_CONN |
重新使用已存在连接时允许的最大空闲时间。默认最大时间设置为 118 秒。
|
||
CURLOPT_MAXFILESIZE_LARGE |
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.
|
||
CURLOPT_MAXLIFETIME_CONN |
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. | ||
CURLOPT_MAXCONNECTS |
允许的最大持久连接数。当达到限制时,将会关闭缓存中最早的连接,以防止增加已打开的连接数。 | ||
CURLOPT_MAXREDIRS |
指定最多的 HTTP 重定向次数,这个选项是和 CURLOPT_FOLLOWLOCATION 一起使用的。
默认值 20 是为了防止无限重定向。设置为 -1 允许无限重定向,0 拒绝所有重定向。
|
||
CURLOPT_PORT |
用来指定连接端口。 | ||
CURLOPT_POSTREDIR |
位掩码, 1 (301 永久重定向), 2 (302 Found)
和 4 (303 See Other)
设置 CURLOPT_FOLLOWLOCATION 时,什么情况下需要再次 HTTP POST 到重定向网址。
|
cURL 7.19.1 中添加。 | |
CURLOPT_PROTOCOLS |
可用的协议选项为:
|
在 cURL 7.19.4 中被加入。 | |
CURLOPT_PROXYAUTH |
HTTP 代理连接的验证方式。使用在CURLOPT_HTTPAUTH 中的位掩码。
当前仅仅支持 CURLAUTH_BASIC 和CURLAUTH_NTLM 。
|
在 cURL 7.10.7 中被加入。 | |
CURLOPT_PROXYPORT |
代理服务器的端口。端口也可以在CURLOPT_PROXY 中设置。
|
||
CURLOPT_PROXYTYPE |
可以是 CURLPROXY_HTTP (默认值)
CURLPROXY_SOCKS4 、
CURLPROXY_SOCKS5 、
CURLPROXY_SOCKS4A 或
CURLPROXY_SOCKS5_HOSTNAME 。
|
在 cURL 7.10 中被加入。 | |
CURLOPT_REDIR_PROTOCOLS |
CURLPROTO_* 值的位掩码。如果被启用,位掩码会限制 libcurl 在 CURLOPT_FOLLOWLOCATION 开启时,使用的协议。
默认允许除 FILE 和 SCP 外所有协议。
这和 7.19.4 前的版本无条件支持所有支持的协议不同。关于协议常量,请参照CURLOPT_PROTOCOLS 。
|
在 cURL 7.19.4 中被加入。 | |
CURLOPT_RESUME_FROM |
在恢复传输时,传递字节为单位的偏移量(用来断点续传)。 | ||
CURLOPT_SOCKS5_AUTH |
用于 SOCKS5 验证方法。选项是:
位操作符
默认为 |
从 7.3.0 和 curl >= 7.55.0 开始可用。 | |
CURLOPT_SSL_OPTIONS |
设置 SSL 行为选项,它是以下常量的位掩码:
|
自 cURL 7.25.0 添加,并且自 PHP 7.0.7 起可用。 | |
CURLOPT_SSL_VERIFYHOST |
2 时验证 SSL 对等证书中的公用名称字段或主题备用名称(Subject Alternate Name,简称 SNA)字段是否与提供的主机名匹配。0
时不检查名称。不应使用 1 。在生产环境中,此选项的值应保持为 2 (默认值)。
|
在 cURL 7.28.1 中移除了对 1 的支持。
|
|
CURLOPT_SSLVERSION |
CURL_SSLVERSION_MAX_* 中的常量来设置最大 TLS 版本。
还可以将 警告
最好不要设置此选项并使用默认值。因为考虑到 SSLv2 和 SSLv3 中已知的漏洞,将其设置为
|
||
CURLOPT_PROXY_SSL_OPTIONS |
设置代理 SSL 行为选项,它是以下常量的位掩码:
|
自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 | |
CURLOPT_PROXY_SSL_VERIFYHOST |
设置为 2 以根据代理名称验证 HTTPS 代理的证书名称字段。设置为 0 时,无论证书中使用的名称如何,连接都会成功。谨慎使用该能力!
在 curl 7.28.0 及更早版本中 1 视为调试选项。从 curl 7.28.1 到 7.65.3 返回 CURLE_BAD_FUNCTION_ARGUMENT 。
从 curl 7.66.0 开始,1 和 2 被视为相同的值。在生产环境中,此选项的值应保持为 2 (默认值)。
|
自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 | |
CURLOPT_PROXY_SSLVERSION |
警告
最好不要设置此选项并使用默认的 |
自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 | |
CURLOPT_STREAM_WEIGHT |
设置 stream weight 数值 ( 1 和 256 之间的数字). | cURL 7.46.0 中添加,自 PHP 7.0.7 起有效。 | |
CURLOPT_TCP_KEEPALIVE |
如果设置为 1 ,将发送 TCP keepalive 探针。这些探针的延迟和频率可以通过 CURLOPT_TCP_KEEPIDLE 和 CURLOPT_TCP_KEEPINTVL
选项来控制,前提是操作系统支持它们。如果设置为 0 (默认值),将禁用 keepalive 探针。
|
在 cURL 7.25.0 中添加。 | |
CURLOPT_TCP_KEEPIDLE |
设置延迟(以秒为单位),如果启用了 CURLOPT_TCP_KEEPALIVE ,操作系统将在连接空闲时等待,然后再发送
keepalive 探针。并非所有操作系统都支持此选项。默认值为 60 。
|
在 cURL 7.25.0 中添加。 | |
CURLOPT_TCP_KEEPINTVL |
设置间隔(以秒为单位),如果启用了 CURLOPT_TCP_KEEPALIVE ,操作系统将在发送
keepalive 探针之间等待。并非所有操作系统都支持此选项。默认值为 60 。
|
在 cURL 7.25.0 中添加。 | |
CURLOPT_TIMECONDITION |
设置如何对待 CURLOPT_TIMEVALUE 。
使用 CURL_TIMECOND_IFMODSINCE ,仅在页面 CURLOPT_TIMEVALUE 之后修改,才返回页面。没有修改则返回
"304 Not Modified" 头,假设设置了 CURLOPT_HEADER 为 true 。CURL_TIMECOND_IFUNMODSINCE
则起相反的效果。使用 CURL_TIMECOND_NONE 忽略 CURLOPT_TIMEVALUE 并始终返回页面。默认为
CURL_TIMECOND_IFMODSINCE 。
|
在 cURL 7.46.0 之前,默认值为 CURL_TIMECOND_IFMODSINCE 。
|
|
CURLOPT_TIMEOUT |
允许 cURL 函数执行的最长秒数。 | ||
CURLOPT_TIMEOUT_MS |
设置cURL允许执行的最长毫秒数。 如果 libcurl 编译时使用系统标准的名称解析器( standard system name resolver),那部分的连接仍旧使用以秒计的超时解决方案,最小超时时间还是一秒钟。 | 在 cURL 7.16.2 中被加入。 | |
CURLOPT_TIMEVALUE |
秒数,从 1970年1月1日开始。这个时间将由 CURLOPT_TIMECONDITION 使用。
|
||
CURLOPT_UPKEEP_INTERVAL_MS |
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.
Default is 60 seconds.
|
||
CURLOPT_UPLOAD_BUFFERSIZE |
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. | ||
CURLOPT_MAX_RECV_SPEED_LARGE |
如果下载速度超过了此速度(以每秒字节数来统计) ,即传输过程中累计的平均数,传输就会降速到这个参数的值。默认不限速。 | cURL 7.15.5 中添加。 | |
CURLOPT_MAX_SEND_SPEED_LARGE |
如果上传的速度超过了此速度(以每秒字节数来统计),即传输过程中累计的平均数 ,传输就会降速到这个参数的值。默认不限速。 | cURL 7.15.5 中添加。 | |
CURLOPT_SSH_AUTH_TYPES |
A bitmask consisting of one or more of
CURLSSH_AUTH_PUBLICKEY ,
CURLSSH_AUTH_PASSWORD ,
CURLSSH_AUTH_HOST ,
CURLSSH_AUTH_KEYBOARD . Set to
CURLSSH_AUTH_ANY to let libcurl pick one.
|
cURL 7.16.1 中添加。 | |
CURLOPT_IPRESOLVE |
允许程序选择想要解析的 IP 地址类别。只有在地址有多种 ip 类别的时候才能用,可以的值有:
CURL_IPRESOLVE_WHATEVER 、
CURL_IPRESOLVE_V4 、
CURL_IPRESOLVE_V6 ,默认是
CURL_IPRESOLVE_WHATEVER 。
|
cURL 7.10.8 中添加。 | |
CURLOPT_FTP_FILEMETHOD |
告诉 curl 使用哪种方式来获取 FTP(s) 服务器上的文件。可能的值有:
CURLFTPMETHOD_DEFAULT 、
CURLFTPMETHOD_MULTICWD 、
CURLFTPMETHOD_NOCWD 和
CURLFTPMETHOD_SINGLECWD 。
|
cURL 7.15.1 中添加。 |
对于下面的这些option
,value
应该被设置成 string:
选项 | 设置的value |
备注 |
---|---|---|
CURLOPT_ALTSVC |
Pass 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 .
|
|
CURLOPT_ALTSVC_CTRL |
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. The options are:
CURLALTSVC_H1 ,
CURLALTSVC_H2 ,
CURLALTSVC_H3 , and
CURLALTSVC_READONLYFILE .
|
|
CURLOPT_AWS_SIGV4 |
Provides AWS V4 signature authentication on HTTP(S) header.
This option overrides any other authentication types that have been set in
|
|
CURLOPT_CAINFO |
一个保存着1个或多个用来让服务端验证的证书的文件名。这个参数仅仅在和CURLOPT_SSL_VERIFYPEER 一起使用时才有意义。 .
|
可能需要绝对路径。 |
CURLOPT_CAINFO_BLOB |
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 |
一个保存着多个CA证书的目录。这个选项是和CURLOPT_SSL_VERIFYPEER 一起使用的。
|
|
CURLOPT_COOKIE |
设定 HTTP 请求中"Cookie: " 部分的内容。多个 cookie 用分号分隔,分号后带一个空格(例如, "fruit=apple; colour=red ")。
|
|
CURLOPT_COOKIEFILE |
包含 cookie 数据的文件名,cookie 文件的格式可以是 Netscape 格式,或者只是纯 HTTP 头部风格,存入文件。如果文件名是空的,不会加载 cookie,但 cookie 的处理仍旧启用。 | |
CURLOPT_COOKIEJAR |
当调用句柄的析构函数时,用于保存所有内部 cookie 的文件的名称。
警告
从 PHP 8.0.0 开始,curl_close() 为空操作(什么都不做),不会销毁句柄。如果需要在句柄自动销毁之前写入 cookie,请在句柄上调用 unset()。 |
|
CURLOPT_COOKIELIST |
cookie 字符串(即 Netscape/Mozilla 的单行格式,或常规 HTTP 样式的 Set-Cookie 头)将单个 cookie 添加到内部 cookie 存储中。
"ALL" 擦除内存中保存的所有 cookie。
"SESS" 擦除内存中保存的所有会话 cookie。
"FLUSH" 将所有已知的 cookie 写入到 CURLOPT_COOKIEJAR 指定的文件。
"RELOAD" 从 CURLOPT_COOKIEFILE 指定的文件中加载所有 cookie。
|
自 cURL 7.14.1 起可用。 |
CURLOPT_CUSTOMREQUEST |
HTTP 请求时,使用自定义的 Method 来代替
|
|
CURLOPT_DEFAULT_PROTOCOL |
URL不带协议的时候,使用的默认协议。 |
cURL 7.45.0 中添加,自 PHP 7.0.7 起有效。 |
CURLOPT_DNS_INTERFACE |
Set the name of the network interface that the DNS resolver should bind to. This must be an interface name (not an address). |
Added in cURL 7.33.0. Available since PHP 7.0.7. |
CURLOPT_DNS_LOCAL_IP4 |
Set the local IPv4 address that the resolver should bind to. The argument should contain a single numerical IPv4 address as a string. |
Added in cURL 7.33.0. Available since PHP 7.0.7. |
CURLOPT_DNS_LOCAL_IP6 |
Set the local IPv6 address that the resolver should bind to. The argument should contain a single numerical IPv6 address as a string. |
Added in cURL 7.33.0. Available since PHP 7.0.7. |
CURLOPT_EGDSOCKET |
类似CURLOPT_RANDOM_FILE ,除了一个Entropy Gathering Daemon套接字。
|
|
CURLOPT_ENCODING |
HTTP请求头中"Accept-Encoding: " 的值。
这使得能够解码响应的内容。
支持的编码有"identity" ,"deflate" 和"gzip" 。如果为空字符串"" ,会发送所有支持的编码类型。
|
在 cURL 7.10 中被加入。 |
CURLOPT_FTPPORT |
这个值将被用来获取供FTP"PORT"指令所需要的IP地址。 "PORT" 指令告诉远程服务器连接到我们指定的IP地址。这个字符串可以是纯文本的IP地址、主机名、一个网络接口名(UNIX下)或者只是一个'-'来使用默认的 IP 地址。 | |
CURLOPT_HSTS |
HSTS (HTTP Strict Transport Security) cache file name. |
|
CURLOPT_HSTS_CTRL |
Controls HSTS (HTTP Strict Transport Security) behavior. Populate the bitmask with the correct set of
features to instruct cURL how to handle HSTS for the transfers using this handle.
|
|
CURLOPT_INTERFACE |
发送的网络接口(interface),可以是一个接口名、IP 地址或者是一个主机名。 | |
CURLOPT_KEYPASSWD |
使用 CURLOPT_SSLKEY
或 CURLOPT_SSH_PRIVATE_KEYFILE 私钥时候的密码。
|
在 cURL 7.16.1 中添加。 |
CURLOPT_KRB4LEVEL |
KRB4 (Kerberos 4) 安全级别。下面的任何值都是有效的(从低到高的顺序):"clear" 、"safe" 、"confidential" 、"private". 。如果字符串以上这些,将使用"private" 。
这个选项设置为 null 时将禁用 KRB4 安全认证。目前 KRB4 安全认证只能用于 FTP 传输。
|
|
CURLOPT_LOGIN_OPTIONS |
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.
|
Added in cURL 7.34.0. Available since PHP 7.0.7. |
CURLOPT_PINNEDPUBLICKEY |
Set the pinned public key. The string can be the file name of your pinned public key. The file format expected is "PEM" or "DER". The string can also be any number of base64 encoded sha256 hashes preceded by "sha256//" and separated by ";". | Added in cURL 7.39.0. Available since PHP 7.0.7. |
CURLOPT_POSTFIELDS |
在 HTTP “POST”操作中要发送的所有数据。
这个参数可以是 urlencoded 后的字符串,类似'para1=val1¶2=val2&... ',也可以使用一个以字段名为键值,字段数据为值的数组。
如果value 是一个数组,Content-Type 头将会被设置成multipart/form-data 。
可以使用 CURLFile 或 CURLStringFile 发送文件,在这种情况下,value 必须是数组。
|
|
CURLOPT_PRIVATE |
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.
|
Added in cURL 7.10.3. |
CURLOPT_PRE_PROXY |
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.
|
自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 |
CURLOPT_PROXY |
HTTP 代理通道。 | |
CURLOPT_PROXY_SERVICE_NAME |
代理验证服务的名称。 | 在 cURL 7.43.0 中添加了 HTTP 代理,在 cURL 7.49.0 中添加了 SOCKS5 代理。自 PHP 7.0.7 起可用。 |
CURLOPT_PROXY_CAINFO |
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 libcurl's cacert bundle is assumed to be stored. | 自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 |
CURLOPT_PROXY_CAINFO_BLOB |
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 libcurl's cacert bundle is assumed to be stored. | Available as of PHP 8.2.0 and libcurl >= cURL 7.77.0. |
CURLOPT_PROXY_CAPATH |
The directory holding multiple CA certificates to verify the HTTPS proxy with. | 自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 |
CURLOPT_PROXY_CRLFILE |
Set 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. | 自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 |
CURLOPT_PROXY_KEYPASSWD |
Set the string be used as the password required to use the
CURLOPT_PROXY_SSLKEY private key. You never needed a
passphrase to load a certificate but you need one to load your private key.
This option is for connecting to an HTTPS proxy, not an HTTPS server.
|
自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 |
CURLOPT_PROXY_PINNEDPUBLICKEY |
Set the pinned public key for HTTPS proxy. The string can be the file name of your pinned public key. The file format expected is "PEM" or "DER". The string can also be any number of base64 encoded sha256 hashes preceded by "sha256//" and separated by ";" | 自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 |
CURLOPT_PROXY_SSLCERT |
The file name of your 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
you wish to authenticate with as it is named in the security database.
If you want to use a file from the current directory, please precede it with
"./" prefix, in order to avoid confusion with a nickname.
|
自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 |
CURLOPT_PROXY_SSLCERTTYPE |
The format of your 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". | 自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 |
CURLOPT_PROXY_SSL_CIPHER_LIST |
The list of ciphers to use for the connection to the HTTPS proxy. The list must be syntactically correct, it consists of one or more cipher strings separated by colons. Commas or spaces are also acceptable separators but colons are normally used, !, - and + can be used as operators. | 自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 |
CURLOPT_PROXY_TLS13_CIPHERS |
The list of cipher suites to use for the TLS 1.3 connection to a proxy.
The list must be syntactically correct, it consists of one or more
cipher suite strings separated by colons. This option is currently used
only when curl is built to use OpenSSL 1.1.1 or later.
If you are using a different SSL backend you can try setting
TLS 1.3 cipher suites by using the CURLOPT_PROXY_SSL_CIPHER_LIST option.
|
自 PHP 7.3.0 和 libcurl >= cURL 7.61.0 起可用。使用 OpenSSL >= 1.1.1 编译时可用。 |
CURLOPT_PROXY_SSLKEY |
The file name of your 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.
|
自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。如果启用内置 TLS,则可用。 |
CURLOPT_PROXY_SSLKEYTYPE |
The format of your private key. Supported formats are "PEM", "DER" and "ENG". | 自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 |
CURLOPT_PROXY_TLSAUTH_PASSWORD |
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.
|
自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 |
CURLOPT_PROXY_TLSAUTH_TYPE |
用于 HTTPS 连接的 TLS 身份验证方法。支持的方法是 "SRP" 。
|
自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 |
CURLOPT_PROXY_TLSAUTH_USERNAME |
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.
|
自 PHP 7.3.0 和 libcurl >= cURL 7.52.0 起可用。 |
CURLOPT_PROXYUSERPWD |
一个用来连接到代理的 "[username]:[password]" 格式的字符串。
|
|
CURLOPT_RANDOM_FILE |
一个被用来生成 SSL 随机数种子的文件名。 | |
CURLOPT_RANGE |
以"X-Y" 的形式,其中X和Y都是可选项获取数据的范围,以字节计。HTTP传输线程也支持几个这样的重复项中间用逗号分隔如"X-Y,N-M" 。
|
|
CURLOPT_REFERER |
在HTTP请求头中"Referer: " 的内容。
|
|
CURLOPT_SASL_AUTHZID |
The authorization identity (authzid) 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. | |
CURLOPT_SERVICE_NAME |
验证服务的名称 | cURL 7.43.0 起添加,自 PHP 7.0.7 有效。 |
CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 |
包含 32 位长的 16 进制数值。这个字符串应该是远程主机公钥(public key) 的 MD5 校验值。在不匹配的时候 libcurl 会拒绝连接。 此选项仅用于 SCP 和 SFTP 的传输。 | cURL 7.17.1 中添加。 |
CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256 |
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. | |
CURLOPT_SSH_PUBLIC_KEYFILE |
The file name for your public key. If not used, libcurl 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. | Added in cURL 7.16.1. |
CURLOPT_SSH_PRIVATE_KEYFILE |
The file name for your private key. If not used, libcurl 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 .
|
Added in cURL 7.16.1. |
CURLOPT_SSL_CIPHER_LIST |
一个SSL的加密算法列表。例如RC4-SHA 和TLSv1 都是可用的加密列表。
|
|
CURLOPT_SSL_EC_CURVES |
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.
|
|
CURLOPT_SSLCERT |
一个包含 PEM 格式证书的文件名。 | |
CURLOPT_SSLCERTPASSWD |
使用CURLOPT_SSLCERT 证书需要的密码。
|
|
CURLOPT_SSLCERTTYPE |
证书的类型。支持的格式有"PEM" (默认值), "DER" 和"ENG" 。
|
在 cURL 7.9.3中 被加入。 |
CURLOPT_SSLENGINE |
用来在CURLOPT_SSLKEY 中指定的SSL私钥的加密引擎变量。
|
|
CURLOPT_SSLENGINE_DEFAULT |
用来做非对称加密操作的变量。 | |
CURLOPT_SSLKEY |
包含 SSL 私钥的文件名。 | |
CURLOPT_SSLKEYPASSWD |
在
|
|
CURLOPT_SSLKEYTYPE |
CURLOPT_SSLKEY 中规定的私钥的加密类型,支持的密钥类型为"PEM" (默认值)、"DER" 和"ENG" 。
|
|
CURLOPT_TLS13_CIPHERS |
用于 TLS 1.3 连接的加密套件列表。列表必须在语法上正确,它由一个或多个用冒号分隔的加密套件字符串组成。当前仅当 curl 编译为使用 OpenSSL 1.1.1
或更高版本时才使用此选项。如果使用不同的 SSL 后端,CURLOPT_SSL_CIPHER_LIST 选项设置 TLS 1.3 加密套件。
|
自 PHP 7.3.0 和 libcurl >= cURL 7.61.0 起可用。使用 OpenSSL >= 1.1.1 编译时可用。 |
CURLOPT_UNIX_SOCKET_PATH |
使用 Unix 套接字作为连接,并用指定的 string 作为路径。 | cURL 7.40.0 中添加, PHP 7.0.7 起有效。 |
CURLOPT_URL |
需要获取的 URL 地址,也可以在curl_init() 初始化会话的时候。 | |
CURLOPT_USERAGENT |
在HTTP请求中包含一个"User-Agent: " 头的字符串。
|
|
CURLOPT_USERNAME |
用于身份验证的用户名。 | cURL 7.19.1 中添加。 |
CURLOPT_PASSWORD |
用于身份验证的密码。 | cURL 7.19.1 中添加。 |
CURLOPT_USERPWD |
传递一个连接中需要的用户名和密码,格式为:"[username]:[password]" 。
|
|
CURLOPT_XOAUTH2_BEARER |
指定 OAuth 2.0 access token。 | cURL 7.33.0 中添加,自 PHP 7.0.7 添加。 |
以下option
,value
应该被设置成数组:
选项 | 可选value 值 |
备注 |
---|---|---|
CURLOPT_CONNECT_TO |
连接到指定的主机和端口,替换 URL 中的主机和端口。接受指定字符串格式的数组:
HOST:PORT:CONNECT-TO-HOST:CONNECT-TO-PORT 。
|
cURL 7.49.0 中添加, PHP 7.0.7 起有效。 |
CURLOPT_HTTP200ALIASES |
HTTP 200 响应码数组,数组中的响应码被认为是正确的响应,而非错误。 | 在 cURL 7.10.3 中被加入。 |
CURLOPT_HTTPHEADER |
设置 HTTP 头字段的数组。格式:
array('Content-type: text/plain', 'Content-length: 100')
|
|
CURLOPT_POSTQUOTE |
在 FTP 请求执行完成后,在服务器上执行的一组array格式的 FTP 命令。 | |
CURLOPT_PROXYHEADER |
传给代理的自定义 HTTP 头。 | cURL 7.37.0 中添加,自 PHP 7.0.7 添加。 |
CURLOPT_QUOTE |
一组先于 FTP 请求的在服务器上执行的FTP命令。 | |
CURLOPT_RESOLVE |
提供自定义地址,指定了主机和端口。
包含主机、端口和 ip 地址的字符串,组成 array 的,每个元素以冒号分隔。格式:
array("example.com:80:127.0.0.1")
|
在 cURL 7.21.3 中添加。 |
以下 option
,value
应该被设置成流资源
(例如使用fopen()):
选项 | 可选value 值 |
---|---|
CURLOPT_FILE |
设置输出文件,默认为STDOUT (浏览器)。
|
CURLOPT_INFILE |
上传文件时需要读取的文件。 |
CURLOPT_STDERR |
错误输出的地址,取代默认的STDERR 。
|
CURLOPT_WRITEHEADER |
设置 header 部分内容的写入的文件地址。 |
以下option
的 value
应该是有效的函数或者闭包:
选项 | 设置 value 为 |
笔记 |
---|---|---|
CURLOPT_HEADERFUNCTION |
设置一个回调函数,这个函数有两个参数,第一个是cURL的资源句柄,第二个是输出的 header 数据。header数据的输出必须依赖这个函数,返回已写入的数据大小。 | |
CURLOPT_PASSWDFUNCTION |
设置一个回调函数,有三个参数,第一个是cURL的资源句柄,第二个是一个密码提示符,第三个参数是密码长度允许的最大值。返回密码的值。 | 从 PHP 7.3.0 开始移除。 |
CURLOPT_PROGRESSFUNCTION |
设置一个回调函数,有五个参数,第一个是cURL的资源句柄,第二个是预计要下载的总字节(bytes)数。第三个是目前下载的字节数,第四个是预计传输中总上传字节数,第五个是目前上传的字节数。
返回非零值将中断传输。
传输将设置 |
|
CURLOPT_READFUNCTION |
回调函数名。该函数应接受三个参数。第一个是 cURL resource;第二个是通过选项
CURLOPT_INFILE 传给 cURL 的 stream resource;第三个参数是最大可以读取的数据的数量。回
调函数必须返回一个字符串,长度小于或等于请求的数据量(第三个参数)。一般从传入的 stream
resource 读取。返回空字符串作为 EOF (文件结束) 信号。
|
|
CURLOPT_WRITEFUNCTION |
回调函数名。该函数应接受两个参数。第一个是 cURL resource;第二个是要写入的数据字符串。数 据必须在函数中被保存。 函数必须准确返回写入数据的字节数,否则传输会被一个错误所中 断。 | |
CURLOPT_XFERINFOFUNCTION |
接受两个参数的回调。与 CURLOPT_PROGRESSFUNCTION 具有相似的目的,但更现代并且是 cURL 的首选选项。
|
在 7.32.0 中添加。 从 PHP 8.2.0 开始可用。 |
其他值:
Option | 设置 value 为 |
---|---|
CURLOPT_SHARE |
curl_share_init() 返回的结果。 使 cURL 可以处理共享句柄里的数据。 |
示例 #1 初始化一个新的cURL会话并获取一个网页
<?php
// 创建一个新cURL资源
$ch = curl_init();
// 设置URL和相应的选项
curl_setopt($ch, CURLOPT_URL, "http://www.example.com/");
curl_setopt($ch, CURLOPT_HEADER, false);
// 抓取URL并把它传递给浏览器
curl_exec($ch);
//关闭cURL资源,并且释放系统资源
curl_close($ch);
?>
注意:
传递一个数组到
CURLOPT_POSTFIELDS
,cURL会把数据编码成 multipart/form-data,而然传递一个URL-encoded字符串时,数据会被编码成 application/x-www-form-urlencoded。