設定 cURL 傳輸選項

curl_setopt

(PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8)

curl_setopt設定 cURL 傳輸選項

說明

curl_setopt(resource $ch, int $option, mixed $value): bool

為 cURL 會話控制代碼設定選項。

參數

handle

curl_init() 返回的 cURL 控制代碼。

option

需要設定的CURLOPT_XXX選項。

value

將設定在option選項上的值。

以下 option 參數的 value應該被設定成 bool 型別:

選項 value 設定為 備註
CURLOPT_AUTOREFERER true 時將根據 Location: 重定向時,自動設定 header 中的Referer:資訊。
CURLOPT_BINARYTRANSFER 設為 true ,將在啟用 CURLOPT_RETURNTRANSFER 時,返回原生的(Raw)輸出。 從 PHP 5.1.3 開始,此選項不再有效果:使用 CURLOPT_RETURNTRANSFER 后總是會返回原生的(Raw)內容。
CURLOPT_COOKIESESSION 設為 true 時將開啟新的一次 cookie 會話。它將強制 libcurl 忽略之前會話時存的其他 cookie。 libcurl 在預設狀況下無論是否為會話,都會儲存、載入所有 cookie。會話 cookie 是指沒有過期時間,只存活在會話之中。
CURLOPT_CERTINFO true 將在安全傳輸時輸出 SSL 證書資訊到 STDERR 在 cURL 7.19.1 中新增。 PHP 5.3.2 後有效。 需要開啟 CURLOPT_VERBOSE 才有效。
CURLOPT_CONNECT_ONLY true 將讓庫執行所有需要的代理、驗證、連線過程,但不傳輸數據。此選項用於 HTTP、SMTP 和 POP3。 在 7.15.2 中新增。 PHP 5.5.0 起有效。
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: " 重定向。(注意:這是遞迴的,"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 演算法,就是減少網路上的小包數量。 PHP 5.2.1 有效,編譯時需要 libcurl 7.11.2 及以上。
CURLOPT_FTPASCII CURLOPT_TRANSFERTEXT 的別名。
CURLOPT_FTPLISTONLY true 時只列出 FTP 目錄的名字。
CURLOPT_HEADER 啟用時會將標頭檔案的資訊作為數據流輸出。
CURLINFO_HEADER_OUT true 時追蹤控制代碼的請求字串。 從 PHP 5.1.3 開始可用。CURLINFO_ 的字首是有意的(intentional)。
CURLOPT_HTTPGET true 時會設定 HTTP 的 method 為 GET,由於預設是 GET,所以只有 method 被修改時才需要這個選項。
CURLOPT_HTTPPROXYTUNNEL true 會通過指定的 HTTP 代理來傳輸。
CURLOPT_MUTE true 時將完全靜默,無論是何 cURL 函式。 在 cURL 7.15.5 中移出(可以使用 CURLOPT_RETURNTRANSFER 作為代替)
CURLOPT_NETRC true 時,在連線建立時,訪問~/.netrc檔案獲取使用者名稱和密碼來連線遠端站點。
CURLOPT_NOBODY true 時將不輸出 BODY 部分。同時 Mehtod 變成了 HEAD。修改爲 false 時不會變成 GET。
CURLOPT_NOPROGRESS

true 時關閉 cURL 的傳輸進度。

注意:

PHP 預設自動設定此選項為 true,只有爲了除錯才需要改變設定。

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_INFILECURLOPT_INFILESIZE 中設定。
CURLOPT_RETURNTRANSFER truecurl_exec()獲取的資訊以字串返回,而不是直接輸出。
CURLOPT_SAFE_UPLOAD true 禁用 @ 字首在 CURLOPT_POSTFIELDS 中發送檔案。 意味著 @ 可以在欄位中安全得使用了。 可使用 CURLFile 作為上傳的代替。 PHP 5.5.0 中新增,預設值 false。 PHP 5.6.0 改預設值為 true。. PHP 7 刪除了此選項, 必須使用 CURLFile interface 來上傳檔案。
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_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中指定的檔案。

以下 optionvalue應該被設定成 integer

選項 設定value 備註
CURLOPT_BUFFERSIZE 每次讀入的緩衝的尺寸。當然不保證每次都會完全填滿這個尺寸。 在cURL 7.10中被加入。
CURLOPT_CLOSEPOLICY CURLCLOSEPOLICY_* 中的一個。

注意:

此選項已被廢棄,它不會被實現,永遠不會有效果啦。

PHP 5.6.0 中移除。
CURLOPT_CONNECTTIMEOUT 在嘗試連線時等待的秒數。設定為0,則無限等待。
CURLOPT_CONNECTTIMEOUT_MS 嘗試連線等待的時間,以毫秒為單位。設定為0,則無限等待。 如果 libcurl 編譯時使用系統標準的名稱解析器( standard system name resolver),那部分的連線仍舊使用以秒計的超時解決方案,最小超時時間還是一秒鐘。 在 cURL 7.16.2 中被加入。從 PHP 5.2.3 開始可用。
CURLOPT_DNS_CACHE_TIMEOUT 設定在記憶體中快取 DNS 的時間,預設為120秒(兩分鐘)。
CURLOPT_EXPECT_100_TIMEOUT_MS 超時預計: 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 How to deal with headers. One of the following constants: CURLHEADER_UNIFIED: the headers specified in CURLOPT_HTTPHEADER will be used in requests both to servers and proxies. With this option enabled, CURLOPT_PROXYHEADER will not have any effect. CURLHEADER_SEPARATE: makes CURLOPT_HTTPHEADER headers only get sent to a server and not to a proxy. Proxy headers must be set with CURLOPT_PROXYHEADER to get used. Note that if a non-CONNECT request is sent to a proxy, libcurl will send both server headers and proxy headers. When doing CONNECT, libcurl will send CURLOPT_PROXYHEADER headers only to the proxy and then CURLOPT_HTTPHEADER headers only to the server. Defaults to CURLHEADER_SEPARATE as of cURL 7.42.1, and CURLHEADER_UNIFIED before. 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 驗證方法。選項有: CURLAUTH_BASICCURLAUTH_DIGESTCURLAUTH_GSSNEGOTIATECURLAUTH_NTLMCURLAUTH_ANYCURLAUTH_ANYSAFE

可以使用 | 位域(OR)操作符結合多個值,cURL 會讓伺服器選擇受支援的方法,並選擇最好的那個。

CURLAUTH_ANYCURLAUTH_BASIC | CURLAUTH_DIGEST | CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM 的別名。

CURLAUTH_ANYSAFECURLAUTH_DIGEST | CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM 的別名。

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_MAXCONNECTS 允許的最大連線數量。達到限制時,會通過CURLOPT_CLOSEPOLICY決定應該關閉哪些連線。
CURLOPT_MAXREDIRS 指定最多的 HTTP 重定向次數,這個選項是和CURLOPT_FOLLOWLOCATION一起使用的。
CURLOPT_PORT 用來指定連線埠。
CURLOPT_POSTREDIR 位掩碼, 1 (301 永久重定向), 2 (302 Found) 和 4 (303 See Other) 設定 CURLOPT_FOLLOWLOCATION 時,什麼情況下需要再次 HTTP POST 到重定向網址。 cURL 7.19.1 中新增,PHP 5.3.2 開始可用。
CURLOPT_PROTOCOLS

CURLPROTO_*的位掩碼。 啟用時,會限制 libcurl 在傳輸過程中可使用哪些協議。 這將允許你在編譯libcurl時支援眾多協議,但是限制只用允許的子集。預設 libcurl 將使用所有支援的協議。 參見CURLOPT_REDIR_PROTOCOLS

可用的協議選項為: CURLPROTO_HTTPCURLPROTO_HTTPSCURLPROTO_FTPCURLPROTO_FTPSCURLPROTO_SCPCURLPROTO_SFTPCURLPROTO_TELNETCURLPROTO_LDAPCURLPROTO_LDAPSCURLPROTO_DICTCURLPROTO_FILECURLPROTO_TFTPCURLPROTO_ALL

在 cURL 7.19.4 中被加入。
CURLOPT_PROXYAUTH HTTP 代理連線的驗證方式。使用在CURLOPT_HTTPAUTH中的位掩碼。 目前僅僅支援 CURLAUTH_BASICCURLAUTH_NTLM 在 cURL 7.10.7 中被加入。
CURLOPT_PROXYPORT 代理伺服器的埠。埠也可以在CURLOPT_PROXY中設定。
CURLOPT_PROXYTYPE 可以是 CURLPROXY_HTTP (預設值) CURLPROXY_SOCKS4CURLPROXY_SOCKS5CURLPROXY_SOCKS4ACURLPROXY_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_SSL_OPTIONS Set SSL behavior options, which is a bitmask of any of the following constants: CURLSSLOPT_ALLOW_BEAST: do not attempt to use any workarounds for a security flaw in the SSL3 and TLS1.0 protocols. CURLSSLOPT_NO_REVOKE: disable certificate revocation checks for those SSL backends where such behavior is present. Added in cURL 7.25.0. Available since PHP 7.0.7.
CURLOPT_SSL_VERIFYHOST 設定為 1 是檢查伺服器SSL證書中是否存在一個公用名(common name)。譯者註:公用名(Common Name)一般來講就是填寫你將要申請SSL證書的域名 (domain)或子域名(sub domain)。 設定成 2,會檢查公用名是否存在,並且是否與提供的主機名匹配。 0 為不檢查名稱。 在生產環境中,這個值應該是 2(預設值)。 1 的支援在 cURL 7.28.1 中被刪除了。
CURLOPT_SSLVERSION CURL_SSLVERSION_DEFAULT (0), CURL_SSLVERSION_TLSv1 (1), CURL_SSLVERSION_SSLv2 (2), CURL_SSLVERSION_SSLv3 (3), CURL_SSLVERSION_TLSv1_0 (4), CURL_SSLVERSION_TLSv1_1 (5) , CURL_SSLVERSION_TLSv1_2 (6) 中的其中一個。

注意:

你最好別設定這個值,讓它使用預設值。 設定為 2 或 3 比較危險,在 SSLv2 和 SSLv3 中有弱點存在。

CURLOPT_STREAM_WEIGHT 設定 stream weight 數值 ( 1 和 256 之間的數字). cURL 7.46.0 中新增,自 PHP 7.0.7 起有效。
CURLOPT_TIMECONDITION 設定如何對待 CURLOPT_TIMEVALUE。 使用 CURL_TIMECOND_IFMODSINCE,僅在頁面 CURLOPT_TIMEVALUE 之後修改,才返回頁面。沒有修改則返回 "304 Not Modified" 頭,假設設定了 CURLOPT_HEADERtrueCURL_TIMECOND_IFUNMODSINCE則起相反的效果。 預設為 CURL_TIMECOND_IFMODSINCE
CURLOPT_TIMEOUT 允許 cURL 函式執行的最長秒數。
CURLOPT_TIMEOUT_MS 設定cURL允許執行的最長毫秒數。 如果 libcurl 編譯時使用系統標準的名稱解析器( standard system name resolver),那部分的連線仍舊使用以秒計的超時解決方案,最小超時時間還是一秒鐘。 在 cURL 7.16.2 中被加入。從 PHP 5.2.3 起可使用。
CURLOPT_TIMEVALUE 秒數,從 1970年1月1日開始。這個時間會被 CURLOPT_TIMECONDITION使。預設使用CURL_TIMECOND_IFMODSINCE
CURLOPT_MAX_RECV_SPEED_LARGE 如果下載速度超過了此速度(以每秒位元組數來統計) ,即傳輸過程中累計的平均數,傳輸就會降速到這個參數的值。預設不限速。 cURL 7.15.5 中新增, PHP 5.4.0 有效。
CURLOPT_MAX_SEND_SPEED_LARGE 如果上傳的速度超過了此速度(以每秒位元組數來統計),即傳輸過程中累計的平均數 ,傳輸就會降速到這個參數的值。預設不限速。 cURL 7.15.5 中新增, PHP 5.4.0 有效。
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_WHATEVERCURL_IPRESOLVE_V4CURL_IPRESOLVE_V6,預設是 CURL_IPRESOLVE_WHATEVER cURL 7.10.8 中新增。
CURLOPT_FTP_FILEMETHOD 告訴 curl 使用哪種方式來獲取 FTP(s) 伺服器上的檔案。可能的值有: CURLFTPMETHOD_MULTICWDCURLFTPMETHOD_NOCWDCURLFTPMETHOD_SINGLECWD cURL 7.15.1 中新增, PHP 5.3.0 起有效。

對於下面的這些optionvalue應該被設定成 string

選項 設定的value 備註
CURLOPT_CAINFO 一個儲存著1個或多個用來讓服務端驗證的證書的檔名。這個參數僅僅在和CURLOPT_SSL_VERIFYPEER一起使用時才有意義。 . 可能需要絕對路徑。
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 連線結束后,比如,呼叫 curl_close 后,儲存 cookie 資訊的檔案。
CURLOPT_CUSTOMREQUEST

HTTP 請求時,使用自定義的 Method 來代替"GET""HEAD"。對 "DELETE" 或者其他更隱蔽的 HTTP 請求有用。 有效值如 "GET""POST""CONNECT"等等;也就是說,不要在這裡輸入整行 HTTP 請求。例如輸入"GET /index.html HTTP/1.0\r\n\r\n"是不正確的。

注意:

不確定伺服器支援這個自定義方法則不要使用它。

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_INTERFACE 發送的網路介面(interface),可以是一個介面名、IP 地址或者是一個主機名。
CURLOPT_KEYPASSWD 使用 CURLOPT_SSLKEYCURLOPT_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" 操作來發送。 要發送檔案,在檔名前面加上@字首並使用完整路徑。 檔案型別可在檔名后以 ';type=mimetype' 的格式指定。 這個參數可以是 urlencoded 后的字串,類似'para1=val1&para2=val2&...',也可以使用一個以欄位名為鍵值,欄位數據為值的陣列。 如果value是一個陣列,Content-Type頭將會被設定成multipart/form-data 從 PHP 5.2.0 開始,使用 @ 字首傳遞檔案時,value 必須是個陣列。 從 PHP 5.5.0 開始, @ 字首已被廢棄,檔案可通過 CURLFile 發送。 設定 CURLOPT_SAFE_UPLOADtrue 可禁用 @ 字首發送檔案,以增加安全性。
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_PROXY HTTP 代理通道。
CURLOPT_PROXY_SERVICE_NAME 代理驗證服務的名稱。 cURL 7.34.0 中新增,PHP 7.0.7 起有效。
CURLOPT_PROXYUSERPWD 一個用來連線到代理的"[username]:[password]"格式的字串。
CURLOPT_RANDOM_FILE 一個被用來產生 SSL 隨機數種子的檔名。
CURLOPT_RANGE "X-Y"的形式,其中X和Y都是可選項獲取數據的範圍,以位元組計。HTTP傳輸執行緒也支援幾個這樣的重複項中間用逗號分隔如"X-Y,N-M"
CURLOPT_REFERER 在HTTP請求頭中"Referer: "的內容。
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_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-SHATLSv1都是可用的加密列表。
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_SSLKEY中指定了的SSL私鑰的密碼。

注意:

由於這個選項包含了敏感的密碼資訊,記得保證這個PHP指令碼的安全。

CURLOPT_SSLKEYTYPE CURLOPT_SSLKEY中規定的私鑰的加密型別,支援的金鑰型別為"PEM"(預設值)、"DER""ENG"
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 中新增,PHP 5.5.0 起有效。
CURLOPT_USERPWD 傳遞一個連線中需要的使用者名稱和密碼,格式為:"[username]:[password]"
CURLOPT_XOAUTH2_BEARER 指定 OAuth 2.0 access token。 cURL 7.33.0 中新增,自 PHP 7.0.7 新增。

以下optionvalue應該被設定成陣列:

選項 可選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 中新增,自 PHP 5.5.0 起可用。

以下 optionvalue應該被設定成流資源 (例如使用fopen()):

選項 可選value
CURLOPT_FILE 設定輸出檔案,預設為STDOUT (瀏覽器)。
CURLOPT_INFILE 上傳檔案時需要讀取的檔案。
CURLOPT_STDERR 錯誤輸出的地址,取代預設的STDERR
CURLOPT_WRITEHEADER 設定 header 部分內容的寫入的檔案地址。

以下optionvalue應該是有效的函式或者閉包:

選項 value
CURLOPT_HEADERFUNCTION 設定一個回撥函式,這個函式有兩個參數,第一個是cURL的資源控制代碼,第二個是輸出的 header 數據。header數據的輸出必須依賴這個函式,返回已寫入的數據大小。
CURLOPT_PASSWDFUNCTION 設定一個回撥函式,有三個參數,第一個是cURL的資源控制代碼,第二個是一個密碼提示符,第三個參數是密碼長度允許的最大值。返回密碼的值。
CURLOPT_PROGRESSFUNCTION

設定一個回撥函式,有五個參數,第一個是cURL的資源控制代碼,第二個是預計要下載的總位元組(bytes)數。第三個是目前下載的位元組數,第四個是預計傳輸中總上傳位元組數,第五個是目前上傳的位元組數。

注意:

只有設定 CURLOPT_NOPROGRESS 選項為 false 時才會呼叫這個回撥函式。

返回非零值將中斷傳輸。 傳輸將設定 CURLE_ABORTED_BY_CALLBACK 錯誤。

CURLOPT_READFUNCTION 回撥函式名。該函式應接受三個參數。第一個是 cURL resource;第二個是通過選項 CURLOPT_INFILE 傳給 cURL 的 stream resource;第三個參數是最大可以讀取的數據的數量。回 調函式必須返回一個字串,長度小於或等於請求的數據量(第三個參數)。一般從傳入的 stream resource 讀取。返回空字串作為 EOF(檔案結束) 訊號。
CURLOPT_WRITEFUNCTION 回撥函式名。該函式應接受兩個參數。第一個是 cURL resource;第二個是要寫入的數據字串。數 據必須在函式中被儲存。 函式必須準確返回寫入數據的位元組數,否則傳輸會被一個錯誤所中 斷。

其他值:

Option 設定 value
CURLOPT_SHARE curl_share_init() 返回的結果。 使 cURL 可以處理共享控制代碼里的數據。

返回值

成功時返回 true, 或者在失敗時返回 false

更新日誌

版本 說明
7.0.7 引入 CURL_HTTP_VERSION_2CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGECURL_HTTP_VERSION_2TLSCURL_REDIR_POST_301CURL_REDIR_POST_302CURL_REDIR_POST_303CURL_REDIR_POST_ALLCURL_VERSION_KERBEROS5CURL_VERSION_PSLCURL_VERSION_UNIX_SOCKETSCURLAUTH_NEGOTIATECURLAUTH_NTLM_WBCURLFTP_CREATE_DIRCURLFTP_CREATE_DIR_NONECURLFTP_CREATE_DIR_RETRYCURLHEADER_SEPARATECURLHEADER_UNIFIEDCURLMOPT_CHUNK_LENGTH_PENALTY_SIZECURLMOPT_CONTENT_LENGTH_PENALTY_SIZECURLMOPT_MAX_HOST_CONNECTIONSCURLMOPT_MAX_PIPELINE_LENGTHCURLMOPT_MAX_TOTAL_CONNECTIONSCURLOPT_CONNECT_TOCURLOPT_DEFAULT_PROTOCOLCURLOPT_DNS_INTERFACECURLOPT_DNS_LOCAL_IP4CURLOPT_DNS_LOCAL_IP6CURLOPT_EXPECT_100_TIMEOUT_MSCURLOPT_HEADEROPTCURLOPT_LOGIN_OPTIONSCURLOPT_PATH_AS_ISCURLOPT_PINNEDPUBLICKEYCURLOPT_PIPEWAITCURLOPT_PROXY_SERVICE_NAMECURLOPT_PROXYHEADERCURLOPT_SASL_IRCURLOPT_SERVICE_NAMECURLOPT_SSL_ENABLE_ALPNCURLOPT_SSL_ENABLE_NPNCURLOPT_SSL_FALSESTARTCURLOPT_SSL_VERIFYSTATUSCURLOPT_STREAM_WEIGHTCURLOPT_TCP_FASTOPENCURLOPT_TFTP_NO_OPTIONSCURLOPT_UNIX_SOCKET_PATHCURLOPT_XOAUTH2_BEARERCURLPROTO_SMBCURLPROTO_SMBSCURLPROXY_HTTP_1_0CURLSSH_AUTH_AGENTCURLSSLOPT_NO_REVOKE

範例

示例 #1 初始化一個新的cURL會話並獲取一個網頁

<?php
// 建立一個新cURL資源
$ch curl_init();

// 設定URL和相應的選項
curl_setopt($chCURLOPT_URL"http://www.example.com/");
curl_setopt($chCURLOPT_HEADERfalse);

// 抓取URL並把它傳遞給瀏覽器
curl_exec($ch);

//關閉cURL資源,並且釋放系統資源
curl_close($ch);
?>

示例 #2 上傳檔案 (PHP 5.5.0 后被廢棄)

<?php

/* http://localhost/upload.php:
print_r($_POST);
print_r($_FILES);
*/

$ch curl_init();

$data = array('name' => 'Foo''file' => '@/home/user/test.png');

curl_setopt($chCURLOPT_URL'http://localhost/upload.php');
curl_setopt($chCURLOPT_POST1);
curl_setopt($chCURLOPT_SAFE_UPLOADfalse); //  PHP 5.6.0 后必須開啟
curl_setopt($chCURLOPT_POSTFIELDS$data);

curl_exec($ch);
?>

以上例程會輸出:

Array
(
    [name] => Foo
)
Array
(
    [file] => Array
        (
            [name] => test.png
            [type] => image/png
            [tmp_name] => /tmp/phpcpjNeQ
            [error] => 0
            [size] => 279
        )

)

註釋

注意:

傳遞一個陣列到CURLOPT_POSTFIELDS,cURL會把數據編碼成 multipart/form-data,而然傳遞一個URL-encoded字串時,數據會被編碼成 application/x-www-form-urlencoded

參見

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。 必填欄位標示為 *