curl_setopt
(PHP 4 >= 4.0.2, PHP 5, PHP 7)
curl_setopt — 设置 cURL 传输选项
bool curl_setopt ( resource $ch , int $option , mixed $value )
为 cURL 会话句柄设置选项。
参数
ch
由 curl_init() 返回的 cURL 句柄。
option
需要设置的CURLOPT_XXX选项。
value
将设置在option
选项上的值。
1 <?php
2 $submit_url = "https://sitename/process.php";
3
4 $curl = curl_init();
5
6 curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC ) ;
7 curl_setopt($curl, CURLOPT_USERPWD, "username:password");
8 curl_setopt($curl, CURLOPT_SSLVERSION,3);
9 curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, FALSE);
10 curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 2);
11 curl_setopt($curl, CURLOPT_HEADER, true);
12 curl_setopt($curl, CURLOPT_POST, true);
13 curl_setopt($curl, CURLOPT_POSTFIELDS, $params );
14 curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
15 curl_setopt($curl, CURLOPT_USERAGENT, "Mozilla/4.0 (compatible; MSIE 5.01; Windows NT 5.0)");
16 curl_setopt($curl, CURLOPT_URL, $submit_url);
17
18 $data = split("text/html", curl_exec($curl) );
19 $temp = split("\r\n", $data[1]) ;
20
21 $result = unserialize( $temp[2] ) ;
22
23 print_r($result);
24 curl_close($curl);
25 ?>
通过提交邮件到HTTPS站点(例如支付网关)提交信息的地方,HTTPS页面在提交信息之前需要基本的身份验证。上面的代码会很有帮助。
如果你想连接到“……”,然后想使用POST数据,这就是方法:
1 <?php
2 $curl = curl_init();
3 curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, FALSE);
4 curl_setopt($curl, CURLOPT_HEADER, 0);
5 curl_setopt($curl, CURLOPT_POST, true);
6 curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
7 curl_setopt($curl, CURLOPT_USERAGENT, "Mozilla/4.0 (compatible; MSIE 5.01; Windows NT 5.0)");
8 curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
9 curl_setopt($curl, CURLOPT_COOKIEFILE, "cookiefile");
10 curl_setopt($curl, CURLOPT_COOKIEJAR, "cookiefile"); # SAME cookiefile
11 curl_setopt($curl, CURLOPT_URL, "url1"); # this is where you first time connect - GET method authorization in my case, if you have POST - need to edit code a bit
12 $xxx = curl_exec($curl);
13
14 curl_setopt($curl, CURLOPT_URL, "url2"); # this is where you are requesting POST-method form results (working with secure connection using cookies after auth)
15 curl_setopt($curl, CURLOPT_POSTFIELDS, "var1=value&var2=value&var3=value&"); # form params that'll be used to get form results
16 $xxx = curl_exec($curl);
17
18 curl_close ($curl);
19 echo $xxx;
20 ?>
当指定文件或curlopt_cookiefile或curlopt_cookiejar你可能需要使用完整的文件路径而不是相对路径。
Example #1 初始化一个新的cURL会话并获取一个网页
1 <?php
2 // 创建一个新cURL资源
3 $ch = curl_init();
4
5 // 设置URL和相应的选项
6 curl_setopt($ch, CURLOPT_URL, "http://www.example.com/");
7 curl_setopt($ch, CURLOPT_HEADER, false);
8
9 // 抓取URL并把它传递给浏览器
10 curl_exec($ch);
11
12 //关闭cURL资源,并且释放系统资源
13 curl_close($ch);
14 ?>
Example #2 上传文件 (PHP 5.5.0 后被废弃)
1 <?php
2
3 /* http://localhost/upload.php:
4 print_r($_POST);
5 print_r($_FILES);
6 */
7
8 $ch = curl_init();
9
10 $data = array('name' => 'Foo', 'file' => '@/home/user/test.png');
11
12 curl_setopt($ch, CURLOPT_URL, 'http://localhost/upload.php');
13 curl_setopt($ch, CURLOPT_POST, 1);
14 curl_setopt($ch, CURLOPT_SAFE_UPLOAD, false); // PHP 5.6.0 后必须开启
15 curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
16
17 curl_exec($ch);
18 ?>
以上例程会输出:
1 Array
2 (
3 [name] => Foo
4 )
5 Array
6 (
7 [file] => Array
8 (
9 [name] => test.png
10 [type] => image/png
11 [tmp_name] => /tmp/phpcpjNeQ
12 [error] => 0
13 [size] => 279
14 )
15
16 )
Note:
传递一个数组到CURLOPT_POSTFIELDS
,cURL会把数据编码成 multipart/form-data,而然传递一个URL-encoded字符串时,数据会被编码成 application/x-www-form-urlencoded。
在PHP5中,对于 “curlopt_postfields” 选项,我们可以使用:
1 <?php
2 $ch = curl_init($URI);
3 $Post = http_build_query($PostData);
4 curl_setopt($ch, CURLOPT_POSTFIELDS, $Post);
5 $Output = curl_exec($ch);
6 curl_close($ch);
7 ?>
以下 option
参数的 value
应该被设置成 bool 类型:
选项 | 将 | 备注 |
|
| |
| 设为 | 从 PHP 5.1.3 开始,此选项不再有效果:使用 |
| 设为 | |
|
| 在 cURL 7.19.1 中添加。 PHP 5.3.2 后有效。 需要开启 |
|
| 在 7.15.2 中添加。 PHP 5.5.0 起有效。 |
| 启用时将Unix的换行符转换成回车换行符。 | |
|
| |
| 当 HTTP 状态码大于等于 400, | |
|
| cURL 7.42.0 中添加。自 PHP 7.0.7 起有效。 |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| PHP 5.2.1 有效,编译时需要 libcurl 7.11.2 及以上。 |
|
| |
|
| |
| 启用时会将头文件的信息作为数据流输出。 | |
|
| 从 PHP 5.1.3 开始可用。 |
|
| |
|
| |
|
| 在 cURL 7.15.5 中移出(可以使用 CURLOPT_RETURNTRANSFER 作为代替) |
|
| |
|
| |
|
| |
|
| cURL 7.10时被加入。 |
|
| cURL 7.42.0 时被加入。 PHP 7.0.7 起有效。 |
|
| cURL 7.43.0 时被加入。 PHP 7.0.7 起有效。 |
|
| |
|
| |
|
| |
|
| PHP 5.5.0 中添加,默认值 |
|
| cURL 7.31.10 中添加,自 PHP 7.0.7 起有效。 |
|
| cURL 7.36.0 中增加, PHP 7.0.7 起有效。 |
|
| cURL 7.36.0 中增加, PHP 7.0.7 起有效。 |
|
| 自cURL 7.10开始默认为 |
|
| cURL 7.41.0 中添加, PHP 7.0.7 起有效。 |
|
| cURL 7.49.0 中添加, PHP 7.0.7 起有效。 |
|
| 自 cURL 7.48.0 添加, PHP 7.0.7 起有效。 |
|
| |
|
| |
|
| |
|
| |
以下 option
的value
应该被设置成 integer:
选项 | 设置 | 备注 |
| 每次读入的缓冲的尺寸。当然不保证每次都会完全填满这个尺寸。 | 在cURL 7.10中被加入。 |
|
| PHP 5.6.0 中移除。 |
| 在尝试连接时等待的秒数。设置为0,则无限等待。 | |
| 尝试连接等待的时间,以毫秒为单位。设置为0,则无限等待。 如果 libcurl 编译时使用系统标准的名称解析器( standard system name resolver),那部分的连接仍旧使用以秒计的超时解决方案,最小超时时间还是一秒钟。 | 在 cURL 7.16.2 中被加入。从 PHP 5.2.3 开始可用。 |
| 设置在内存中缓存 DNS 的时间,默认为120秒(两分钟)。 | |
| 超时预计: 100毫秒内的 continue 响应 默认为 1000 毫秒。 | cURL 7.36.0 中添加,自 PHP 7.0.7 有效。 |
| FTP验证方式(启用的时候):CURLFTPAUTH_SSL (首先尝试SSL),CURLFTPAUTH_TLS (首先尝试TLS)或CURLFTPAUTH_DEFAULT (让cURL 自个儿决定)。 | 在 cURL 7.12.2 中被加入。 |
| How to deal with headers. One of the following constants: | Added in cURL 7.37.0. Available since PHP 7.0.7. |
|
| |
| 使用的 HTTP 验证方法。选项有: 可以使用 | 位域(OR)操作符结合多个值,cURL 会让服务器选择受支持的方法,并选择最好的那个。
| |
| 希望传给远程站点的文件尺寸,字节(byte)为单位。 注意无法用这个选项阻止 libcurl 发送更多的数据,确切发送什么取决于 | |
| 传输速度,每秒字节(bytes)数,根据 | |
| 当传输速度小于 | |
| 允许的最大连接数量。达到限制时,会通过 | |
| 指定最多的 HTTP 重定向次数,这个选项是和 | |
| 用来指定连接端口。 | |
| 位掩码, 1 (301 永久重定向), 2 (302 Found) 和 4 (303 See Other) 设置 | cURL 7.19.1 中添加,PHP 5.3.2 开始可用。 |
|
可用的协议选项为: | 在 cURL 7.19.4 中被加入。 |
| HTTP 代理连接的验证方式。使用在 | 在 cURL 7.10.7 中被加入。 |
| 代理服务器的端口。端口也可以在 | |
| 可以是 | 在 cURL 7.10 中被加入。 |
|
| 在 cURL 7.19.4 中被加入。 |
| 在恢复传输时,传递字节为单位的偏移量(用来断点续传)。 | |
| Set SSL behavior options, which is a bitmask of any of the following constants: | Added in cURL 7.25.0. Available since PHP 7.0.7. |
| 设置为 1 是检查服务器SSL证书中是否存在一个公用名(common name)。译者注:公用名(Common Name)一般来讲就是填写你将要申请SSL证书的域名 (domain)或子域名(sub domain)。 设置成 2,会检查公用名是否存在,并且是否与提供的主机名匹配。 0 为不检查名称。 在生产环境中,这个值应该是 2(默认值)。 | 值 1 的支持在 cURL 7.28.1 中被删除了。 |
|
| |
| 设置 stream weight 数值 ( 1 和 256 之间的数字). | cURL 7.46.0 中添加,自 PHP 7.0.7 起有效。 |
| 设置如何对待 | |
| 允许 cURL 函数执行的最长秒数。 | |
| 设置cURL允许执行的最长毫秒数。 如果 libcurl 编译时使用系统标准的名称解析器( standard system name resolver),那部分的连接仍旧使用以秒计的超时解决方案,最小超时时间还是一秒钟。 | 在 cURL 7.16.2 中被加入。从 PHP 5.2.3 起可使用。 |
| 秒数,从 1970年1月1日开始。这个时间会被 | |
| 如果下载速度超过了此速度(以每秒字节数来统计) ,即传输过程中累计的平均数,传输就会降速到这个参数的值。默认不限速。 | cURL 7.15.5 中添加, PHP 5.4.0 有效。 |
| 如果上传的速度超过了此速度(以每秒字节数来统计),即传输过程中累计的平均数 ,传输就会降速到这个参数的值。默认不限速。 | cURL 7.15.5 中添加, PHP 5.4.0 有效。 |
| A bitmask consisting of one or more of | cURL 7.16.1 中添加。 |
| 允许程序选择想要解析的 IP 地址类别。只有在地址有多种 ip 类别的时候才能用,可以的值有: | cURL 7.10.8 中添加。 |
| 告诉 curl 使用哪种方式来获取 FTP(s) 服务器上的文件。可能的值有: | cURL 7.15.1 中添加, PHP 5.3.0 起有效。 |
对于下面的这些option
,value
应该被设置成 string:
选项 | 设置的 | 备注 |
| 一个保存着1个或多个用来让服务端验证的证书的文件名。这个参数仅仅在和 | 可能需要绝对路径。 |
| 一个保存着多个CA证书的目录。这个选项是和 | |
| 设定 HTTP 请求中"Cookie: "部分的内容。多个 cookie 用分号分隔,分号后带一个空格(例如, "fruit=apple; colour=red")。 | |
| 包含 cookie 数据的文件名,cookie 文件的格式可以是 Netscape 格式,或者只是纯 HTTP 头部风格,存入文件。如果文件名是空的,不会加载 cookie,但 cookie 的处理仍旧启用。 | |
| 连接结束后,比如,调用 curl_close 后,保存 cookie 信息的文件。 | |
| HTTP 请求时,使用自定义的 Method 来代替"GET"或"HEAD"。对 "DELETE" 或者其他更隐蔽的 HTTP 请求有用。 有效值如 "GET","POST","CONNECT"等等;也就是说,不要在这里输入整行 HTTP 请求。例如输入"GET /index.html HTTP/1.0\r\n\r\n"是不正确的。
| |
| URL不带协议的时候,使用的默认协议。 | cURL 7.45.0 中添加,自 PHP 7.0.7 起有效。 |
| 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. |
| 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. |
| 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. |
| 类似 | |
| HTTP请求头中"Accept-Encoding: "的值。 这使得能够解码响应的内容。 支持的编码有"identity","deflate"和"gzip"。如果为空字符串"",会发送所有支持的编码类型。 | 在 cURL 7.10 中被加入。 |
| 这个值将被用来获取供FTP"PORT"指令所需要的IP地址。 "PORT" 指令告诉远程服务器连接到我们指定的IP地址。这个字符串可以是纯文本的IP地址、主机名、一个网络接口名(UNIX下)或者只是一个'-'来使用默认的 IP 地址。 | |
| 发送的网络接口(interface),可以是一个接口名、IP 地址或者是一个主机名。 | |
| 使用 | 在 cURL 7.16.1 中添加。 |
| KRB4 (Kerberos 4) 安全级别。下面的任何值都是有效的(从低到高的顺序):"clear"、"safe"、"confidential"、"private".。如果字符串以上这些,将使用"private"。 这个选项设置为 | |
| 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 | Added in cURL 7.34.0. Available since PHP 7.0.7. |
| 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. |
| 全部数据使用HTTP协议中的 "POST" 操作来发送。 要发送文件,在文件名前面加上@前缀并使用完整路径。 文件类型可在文件名后以 ';type=mimetype' 的格式指定。 这个参数可以是 urlencoded 后的字符串,类似'para1=val1¶2=val2&...',也可以使用一个以字段名为键值,字段数据为值的数组。 如果 | |
| Any data that should be associated with this cURL handle. This data can subsequently be retrieved with the | Added in cURL 7.10.3. |
| HTTP 代理通道。 | |
| 代理验证服务的名称。 | cURL 7.34.0 中添加,PHP 7.0.7 起有效。 |
| 一个用来连接到代理的"[username]:[password]"格式的字符串。 | |
| 一个被用来生成 SSL 随机数种子的文件名。 | |
| 以"X-Y"的形式,其中X和Y都是可选项获取数据的范围,以字节计。HTTP传输线程也支持几个这样的重复项中间用逗号分隔如"X-Y,N-M"。 | |
| 在HTTP请求头中"Referer: "的内容。 | |
| 验证服务的名称 | cURL 7.43.0 起添加,自 PHP 7.0.7 有效。 |
| 包含 32 位长的 16 进制数值。这个字符串应该是远程主机公钥(public key) 的 MD5 校验值。在不匹配的时候 libcurl 会拒绝连接。 此选项仅用于 SCP 和 SFTP 的传输。 | cURL 7.17.1 中添加。 |
| 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. |
| 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 | Added in cURL 7.16.1. |
| 一个SSL的加密算法列表。例如RC4-SHA和TLSv1都是可用的加密列表。 | |
| 一个包含 PEM 格式证书的文件名。 | |
| 使用 | |
| 证书的类型。支持的格式有"PEM" (默认值), "DER"和"ENG"。 | 在 cURL 7.9.3中 被加入。 |
| 用来在 | |
| 用来做非对称加密操作的变量。 | |
| 包含 SSL 私钥的文件名。 | |
| 在
| |
|
| |
| 使用 Unix 套接字作为连接,并用指定的 string 作为路径。 | cURL 7.40.0 中添加, PHP 7.0.7 起有效。 |
| 需要获取的 URL 地址,也可以在curl_init() 初始化会话的时候。 | |
| 在HTTP请求中包含一个"User-Agent: "头的字符串。 | |
| 验证中使用的用户名。 | cURL 7.19.1 中添加,PHP 5.5.0 起有效。 |
| 传递一个连接中需要的用户名和密码,格式为:"[username]:[password]"。 | |
| 指定 OAuth 2.0 access token。 | cURL 7.33.0 中添加,自 PHP 7.0.7 添加。 |
以下option
,value
应该被设置成数组:
选项 | 可选 | 备注 |
| 连接到指定的主机和端口,替换 URL 中的主机和端口。接受指定字符串格式的数组: HOST:PORT:CONNECT-TO-HOST:CONNECT-TO-PORT。 | cURL 7.49.0 中添加, PHP 7.0.7 起有效。 |
| HTTP 200 响应码数组,数组中的响应码被认为是正确的响应,而非错误。 | 在 cURL 7.10.3 中被加入。 |
| 设置 HTTP 头字段的数组。格式: | |
| 在 FTP 请求执行完成后,在服务器上执行的一组array格式的 FTP 命令。 | |
| 传给代理的自定义 HTTP 头。 | cURL 7.37.0 中添加,自 PHP 7.0.7 添加。 |
| 一组先于 FTP 请求的在服务器上执行的FTP命令。 | |
| 提供自定义地址,指定了主机和端口。 包含主机、端口和 ip 地址的字符串,组成 array 的,每个元素以冒号分隔。格式: | 在 cURL 7.21.3 中添加,自 PHP 5.5.0 起可用。 |
以下 option
,value
应该被设置成流资源 (例如使用fopen()):
选项 | 可选 |
| 设置输出文件,默认为STDOUT (浏览器)。 |
| 上传文件时需要读取的文件。 |
| 错误输出的地址,取代默认的STDERR。 |
| 设置 header 部分内容的写入的文件地址。 |
以下option
的 value
应该是有效的函数或者闭包:
选项 |
|
| 设置一个回调函数,这个函数有两个参数,第一个是cURL的资源句柄,第二个是输出的 header 数据。header数据的输出必须依赖这个函数,返回已写入的数据大小。 |
| 设置一个回调函数,有三个参数,第一个是cURL的资源句柄,第二个是一个密码提示符,第三个参数是密码长度允许的最大值。返回密码的值。 |
| 设置一个回调函数,有五个参数,第一个是cURL的资源句柄,第二个是预计要下载的总字节(bytes)数。第三个是目前下载的字节数,第四个是预计传输中总上传字节数,第五个是目前上传的字节数。
返回非零值将中断传输。 传输将设置 |
| 回调函数名。该函数应接受三个参数。第一个是 cURL resource;第二个是通过选项 |
| 回调函数名。该函数应接受两个参数。第一个是 cURL resource;第二个是要写入的数据字符串。数 据必须在函数中被保存。 函数必须准确返回写入数据的字节数,否则传输会被一个错误所中 断。 |
其他值:
Option | 设置 |
| curl_share_init() 返回的结果。 使 cURL 可以处理共享句柄里的数据。 |
返回值
成功时返回 TRUE
, 或者在失败时返回 FALSE
。
更新日志
版本 | 说明 |
7.0.7 | 引入 |
7.0.0 | 禁用 |
5.6.0 | 默认 |
5.6.0 | 移出 |
5.5.0 | 添加 cURL 资源作为 |
5.5.0 | 引入 |
5.3.0 | 引入 |
5.2.10 | 引入 |
5.2.4 | 引入了 |
5.1.0 | 引入 |
5.0.0 | 引入 |