php curl_setopt is used to set a cURL transfer option. Its usage syntax is such as "bool curl_setopt(resource $ch, int $option, mixed $value)". This statement sets an option for a given cURL session handle. .
The operating environment of this article: Windows 7 system, PHP version 7.1, DELL G3 computer
For the optional parameters of the following options, value should be set to a bool type value:
Options
OptionalvalueValue
Remarks
CURLOPT_AUTOREFERER
When redirected according to Location:, the Referer: information in the header is automatically set.
##CURLOPT_BINARYTRANSFER
When
CURLOPT_RETURNTRANSFER is enabled, return the native ( Raw) output.
##CURLOPT_COOKIESESSION
When enabled, curl will only pass one session cookie and ignore other cookies. By default In this case, cURL will return all cookies to the server. Session cookies refer to cookies that are used to determine whether the server-side session is valid.
CURLOPT_CRLF
When enabled, convert Unix line feeds into carriage returns and line feeds.
##CURLOPT_DNS_USE_GLOBAL_CACHE
When enabled, a global DNS cache will be enabled. This item is thread-safe. , and is enabled by default.
CURLOPT_FAILONERROR
Display HTTP status code, the default behavior is to ignore HTTP information with a number less than or equal to 400 .
CURLOPT_FILETIME
When enabled, an attempt will be made to modify information in the remote document. The result information will be returned through the CURLINFO_FILETIME
option of the curl_getinfo() function.
curl_getinfo().
CURLOPT_FOLLOWLOCATION
When enabled, the server will return " Location: "
Put it in the header and return it to the server recursively. Use
CURLOPT_MAXREDIRS to limit the number of recursive returns.
##CURLOPT_FORBID_REUSE
Forcibly disconnects after completing the interaction and cannot be reused.
CURLOPT_FRESH_CONNECT
Force to obtain a new connection to replace the one in the cache.
##CURLOPT_FTP_USE_EPRT
When enabled, use the EPRT (or LPRT) command when FTP downloads. When set to
FALSE disables EPRT and LPRT, use the PORT command
only.
##CURLOPT_FTP_USE_EPSV
When enabled, first before reverting to PASV mode during FTP transfer Try the EPSV command. Disables the EPSV command when set to
FALSE
.
CURLOPT_FTPAPPEND
When enabled append writes to the file instead of overwriting it.
##CURLOPT_FTPASCII
## Alias for CURLOPT_TRANSFERTEXT
.
##CURLOPT_FTPLISTONLY
When enabled, only the name of the FTP directory is listed.
CURLOPT_HEADER
When enabled, the header file information will be output as a data stream.
CURLINFO_HEADER_OUT
The request string for the tracking handle when enabled.
Available starting with PHP 5.1.3.
CURLINFO_
The prefix is intentional.
CURLOPT_HTTPGET
When enabled, the HTTP method will be set to GET. Because GET is the default, it is only used when it is modified. .
CURLOPT_HTTPPROXYTUNNEL
When enabled, it will be transmitted through HTTP proxy.
CURLOPT_MUTE
When enabled, all modified parameters in the cURL function will be restored to their default values.
##CURLOPT_NETRC
After the connection is established, visit
~/.netrc The file obtains username and password information to connect to the remote site.
CURLOPT_NOBODY
When enabled, the BODY part in HTML will not be output.
##CURLOPT_NOPROGRESS
Close the progress bar of curl transmission when enabled, the default for this item Set to enabled.
Note
:PHP automatically sets this option to
TRUE
, this option should only be changed for debugging purposes .
CURLOPT_NOSIGNAL
When enabled, ignore all curl passed to php signal of. This item is enabled by default during SAPI multi-threaded transmission.
cURL was added in 7.10.
CURLOPT_POST
When enabled, a regular POST request will be sent, the type is:
application/x-www-form-urlencoded
, just like form submission.
##CURLOPT_PUT
Allows HTTP to send files when enabled. CURLOPT_INFILE## must be set at the same time. # and
CURLOPT_INFILESIZE
.
##CURLOPT_RETURNTRANSFER
Return the information obtained by curl_exec() in the form of a file stream instead of Direct output.
CURLOPT_SSL_VERIFYPEER
After disabling cURL will terminate verification from the server. Use the
CURLOPT_CAINFO option to set the certificate. Use the CURLOPT_CAPATH
option to set the certificate directory.
If
CURLOPT_SSL_VERIFYPEER (default value is 2) is enabled, CURLOPT_SSL_VERIFYHOST needs to be set to TRUE otherwise set to FALSE. Defaults to TRUE since cURL 7.10. Starting with cURL 7.10, bundle installation is defaulted.
CURLOPT_TRANSFERTEXT
Use ASCII mode for FTP transfers when enabled. For LDAP, it retrieves plain text information rather than HTML. On Windows systems, the system does not set
STDOUT to binary mode.
##CURLOPT_UNRESTRICTED_AUTH
Multiple headers generated using
CURLOPT_FOLLOWLOCATION
Username and password information continues to be appended to locations, even if the domain name has changed.
CURLOPT_UPLOAD
Allows file uploads when enabled.
##CURLOPT_VERBOSE
When enabled, all information will be reported and stored in
STDERR
or the specified
CURLOPT_STDERR.
For the optional parameters of the following options, value should be set to an integer type value:
Options
OptionalvalueValue
Remarks
CURLOPT_BUFFERSIZE
The size of the cache read into the data obtained each time, but there is no guarantee that this value will be filled every time.
was added in cURL 7.10.
##CURLOPT_CLOSEPOLICY
Either CURLCLOSEPOLICY_LEAST_RECENTLY_USED or CURLCLOSEPOLICY_OLDEST, there are three other CURLCLOSEPOLICYs, but cURL does not support them yet.
##CURLOPT_CONNECTTIMEOUT
The time to wait before initiating a connection. If set to 0, it will wait indefinitely .
CURLOPT_CONNECTTIMEOUT_MS
The time to wait for a connection attempt, in milliseconds. If set to 0, wait infinitely.
was added in cURL 7.16.2. Available starting with PHP 5.2.3.
CURLOPT_DNS_CACHE_TIMEOUT
Set the time to save DNS information in memory, the default is 120 seconds.
##CURLOPT_FTPSSLAUTH
FTP verification method: CURLFTPAUTH_SSL
(try SSL first) ,
CURLFTPAUTH_TLS (try TLS first) or CURLFTPAUTH_DEFAULT (let cURL decide automatically). was added in cURL 7.12.2.
##CURLOPT_HTTP_VERSION
CURL_HTTP_VERSION_NONE (default value, let cURL decide which version to use),
CURL_HTTP_VERSION_1_0
(force HTTP/1.0) or CURL_HTTP_VERSION_1_1 (force HTTP/1.1).
##CURLOPT_INFILESIZE
Set the size limit of uploaded files in bytes.
##CURLOPT_LOW_SPEED_LIMIT
When the transmission speed is less than
CURLOPT_LOW_SPEED_LIMIT
(bytes/sec ), PHP will determine whether to cancel the transmission because it is too slow based on CURLOPT_LOW_SPEED_TIME.
##CURLOPT_LOW_SPEED_TIME
When the transmission speed is less than
CURLOPT_LOW_SPEED_LIMIT
(bytes/sec ), PHP will determine whether to cancel the transmission because it is too slow based on
CURLOPT_LOW_SPEED_TIME.
##CURLOPT_MAXCONNECTS
The maximum number of connections allowed, if exceeded,
CURLOPT_CLOSEPOLICY## will be passed #Determine which connections should be stopped.
##CURLOPT_MAXREDIRS
Specifies the maximum number of HTTP redirects. This option is the same as
CURLOPT_FOLLOWLOCATION is used together.
CURLOPT_PORT
is used to specify the connection port. (Optional) Bit field pointers to
##CURLOPT_PROTOCOLS
CURLPROTO_*
. If enabled, the bitfield value limits which protocols libcurl can use during transfers. This will allow you to compile libcurl to support a wide range of protocols, but be restricted to using only a subset of them that are allowed to be used. By default libcurl will use all protocols it supports. See CURLOPT_REDIR_PROTOCOLS
. The available protocol options are: CURLPROTO_HTTP, CURLPROTO_HTTPS, CURLPROTO_FTP, CURLPROTO_FTPS, CURLPROTO_SCP, CURLPROTO_SFTP, CURLPROTO_TELNET, CURLPROTO_LDAP, CURLPROTO_LDAPS, CURLPROTO_DICT, CURLPROTO_FILE, CURLPROTO_TF TP, CURLPROTO_ALL
in cURL 7.19. 4 was added. The bit field refers to
CURLOPT_PROTOCOLSCURLPROTO_*
. If enabled, the bitfield value limits which protocols libcurl can use during transfers. This will allow you to compile libcurl to support a wide range of protocols, but be restricted to using only a subset of them that are allowed to be used. By default libcurl will use all protocols it supports. See
CURLOPT_REDIR_PROTOCOLS
. The available protocol options are: CURLPROTO_HTTP, CURLPROTO_HTTPS, CURLPROTO_FTP, CURLPROTO_FTPS, CURLPROTO_SCP, CURLPROTO_SFTP, CURLPROTO_TELNET, CURLPROTO_LDAP, CURLPROTO_LDAPS, CURLPROTO_DICT, CURLPROTO_FILE, CURLPROTO_TF TP, CURLPROTO_ALL
in cURL 7.19. 4 was added.
CURLOPT_PROXYAUTHVerification method for HTTP proxy connection. Use the bitfield flags in CURLOPT_HTTPAUTH
to set the corresponding options. For proxy authentication only
CURLAUTH_BASIC
and
CURLAUTH_NTLM
are currently supported.
was added in cURL 7.10.7.
CURLOPT_PROXYPORTThe port of the proxy server. The port can also be set in CURLOPT_PROXY
.
CURLOPT_PROXYTYPE
is either CURLPROXY_HTTP (default) or CURLPROXY_SOCKS5.
was added in cURL 7.10. Bit field value in
CURLOPT_REDIR_PROTOCOLS
##CURLPROTO_*. If enabled, the bitfield value will limit the protocols that the transport thread can use when following a redirect when CURLOPT_FOLLOWLOCATION is enabled. This will allow you to restrict the transport thread to a subset of allowed protocols when redirecting. By default libcurl will allow all protocols except FILE and SCP. This is slightly different from the 7.19.4 pre-release version which unconditionally follows all supported protocols. For protocol constants, please refer to CURLOPT_PROTOCOLS.
was added in cURL 7.19.4.
CURLOPT_RESUME_FROM
Pass a byte offset when resuming transmission (used for resumed transmission).
CURLOPT_SSL_VERIFYHOST
1 Check whether a common name exists in the server SSL certificate. Translator's Note: Common Name generally means filling in the domain name (domain) or subdomain (sub domain) for which you are going to apply for an SSL certificate. 2 Check that the common name exists and matches the provided host name.
CURLOPT_SSLVERSION
The SSL version to use (2 or 3). By default PHP will detect this value by itself, although in some cases it may need to be set manually.
##CURLOPT_TIMECONDITION
If after a certain time specified by
CURLOPT_TIMEVALUE
If it has been edited, use CURL_TIMECOND_IFMODSINCE to return to the page. If it has not been modified and CURLOPT_HEADER is true, a "304 Not Modified" header will be returned. # If ##CURLOPT_HEADER is false, use CURL_TIMECOND_IFUNMODSINCE. The default value is CURL_TIMECOND_IFUNMODSINCE.
CURLOPT_TIMEOUT
Set the maximum number of seconds cURL is allowed to execute.
##CURLOPT_TIMEOUT_MS
Set the maximum number of milliseconds cURL is allowed to execute. was added in cURL 7.16.2. Available from PHP 5.2.3 onwards.
CURLOPT_TIMEVALUE
Set a timestamp used by CURLOPT_TIMECONDITION. By default,
CURL_TIMECOND_IFMODSINCE is used
.
For the optional parameters of the following options, value should be set to a string type value:
Options
Optional valueValue
Remarks
CURLOPT_CAINFO
One holds 1 or more The file name of the certificate used for verification by the server. This parameter is only meaningful when used with CURLOPT_SSL_VERIFYPEER. .
CURLOPT_CAPATH
A directory that holds multiple CA certificates. This option is used with CURLOPT_SSL_VERIFYPEER.
##CURLOPT_COOKIE
Set the
"Cookie: " part of the HTTP request Content. Multiple cookies are separated by a semicolon followed by a space (for example, "fruit=apple; colour=red").
##CURLOPT_COOKIEFILE
The file name containing cookie data. The format of the cookie file can be Netscape format. Or just save the pure HTTP header information to the file.
CURLOPT_COOKIEJAR
A file that saves cookie information after the connection is completed.
##CURLOPT_CUSTOMREQUEST
Use a custom request message instead
" GET"
or
"HEAD" as an HTTP request. This is useful for performing "DELETE" or other more covert HTTP requests. Valid values include "GET", "POST", "CONNECT", etc. That is, don't enter the entire HTTP request here. For example, entering "GET /index.html HTTP/1.0\r\n\r\n" is incorrect.
Note
:
Do not use this custom request method until you are sure that the server supports it.
##CURLOPT_EGDSOCKET
Similar to
CURLOPT_RANDOM_FILE, except for an Entropy Gathering Daemon socket.
##CURLOPT_ENCODING
"Accept-Encoding: "
in the HTTP request header value. Supported encodings are "identity", "deflate" and "gzip". If it is the empty string "", the request header will send all supported encoding types. was added in cURL 7.10.
CURLOPT_FTPPORT
This value will be used to obtain the IP address required for the FTP "POST" command. The "POST" command tells the remote server to connect to the IP address we specified. This string can be a plain text IP address, a hostname, a network interface name (under UNIX) or just a '-' to use the default IP address.
##CURLOPT_INTERFACE
The network sending interface name can be an interface name, IP address or a CPU name.
CURLOPT_KRB4LEVEL
KRB4 (Kerberos 4) security level. Any of the following values are valid (in order from lowest to highest): "clear"
,
"safe", "confidential", "private".. If the string matches none of these, "private" will be used. Setting this option to NULL will disable KRB4 security authentication. Currently KRB4 security authentication can only be used for FTP transmission.
##CURLOPT_POSTFIELDS
All data is sent using the "POST" operation in the HTTP protocol. To send a file, prefix the file name with @ and use the full path. This parameter can be passed through a urlencoded string like '
para1=val1¶2=val2&...
' or an array with the field name as the key and the field data as the value. If value is an array, the Content-Type header will be set to multipart/form-data.
CURLOPT_PROXY
HTTP proxy channel.
##CURLOPT_PROXYUSERPWD
A number used to connect to the proxy
"[username]:[ password]" format string.
##CURLOPT_RANDOM_FILE
A file name used to generate SSL random number seeds.
##CURLOPT_RANGE
In the form of
"X-Y"
, where X and Y is the range of optional data obtained, measured in bytes. The HTTP transfer thread also supports several such duplicates separated by commas such as
"X-Y,N-M".
##CURLOPT_REFERER
In the HTTP request header
"Referer: "
content.
CURLOPT_SSL_CIPHER_LIST
A list of SSL encryption algorithms. For example,
RC4-SHA
and
TLSv1
are both available encryption lists.
CURLOPT_SSLCERT
The name of a file containing a certificate in PEM format.
##CURLOPT_SSLCERTPASSWD
The password required to use the CURLOPT_SSLCERT
certificate.
CURLOPT_SSLCERTTYPE
Type of certificate. Supported formats are "PEM" (default), "DER" and "ENG".
was added in cURL 7.9.3.
CURLOPT_SSLENGINE
Encryption engine variable used for the SSL private key specified in CURLOPT_SSLKEY.
CURLOPT_SSLENGINE_DEFAULT
Variables used for asymmetric encryption operations.
CURLOPT_SSLKEY
The name of the file containing the SSL private key.
##CURLOPT_SSLKEYPASSWD
The SSL specified in
CURLOPT_SSLKEY The password for the private key.
Note:
Since this option contains sensitive password information, remember to keep this PHP script safe.
##CURLOPT_SSLKEYTYPE
CURLOPT_SSLKEY
The encryption type of the private key. The supported key types are "PEM" (default value), "DER" and "ENG".
##CURLOPT_URL
The URL address that needs to be obtained can also be obtained in curl_init()
Set in function.
##CURLOPT_USERAGENT
Include a "User-Agent: "# in the HTTP request ##Header string.
##CURLOPT_USERPWD
Pass the username and password required for a connection in the format:
"[username]:[password]"
.
For the optional parameters of the following options, value should be set to an array:
OptionsOptional
valueValue
Remarks
# #CURLOPT_HTTP200ALIASES
200 response code array, the response in the array is considered a correct response, otherwise it is considered an error.
was added in cURL 7.10.3.
CURLOPT_HTTPHEADER
An array used to set HTTP header fields. Use an array of the following form to set:
array('Content-type: text/plain', 'Content-length: 100')
##CURLOPT_POSTQUOTE
A set of FTP commands executed on the server after the FTP request is executed.
##CURLOPT_QUOTE
#A set of FTP commands to be executed on the server before the FTP request.
For the optional parameters of the following options, value should be set to a stream resource (for example, using fopen()):
Options
Optional valuevalue
CURLOPT_FILE
Set the location of the output file, the value is one Resource type, default is STDOUT (browser).
CURLOPT_INFILE
The file address that needs to be read when uploading a file, the value is a resource type.
CURLOPT_STDERR
Sets an error output address, the value is a resource type, replacing the default STDERR.
CURLOPT_WRITEHEADER
Set the file address where the header part is written, and the value is a resource type.
For the optional parameters of the following options, value should be set to a callback function name:
Options
OptionalvalueValue
##CURLOPT_HEADERFUNCTION
Set one Callback function, this function has two parameters, the first is the cURL resource handle, and the second is the output header data. The output of header data must rely on this function, which returns the size of the written data.
CURLOPT_PASSWDFUNCTION
Set a callback function with three parameters. The first is the cURL resource handle, and the second is a password prompt. character, the third parameter is the maximum allowed password length. Returns the value of the password.
CURLOPT_PROGRESSFUNCTION
Set a callback function with three parameters. The first is the resource handle of cURL, and the second is a file description. Character resources, the third one is the length. Returns the contained data.
CURLOPT_READFUNCTION
Callback function name. This function should accept three parameters. The first is cURL resource; the second is via options
CURLOPT_INFILE The stream resource passed to cURL; the third parameter is the maximum amount of data that can be read. return
The calling function must return a string whose length is less than or equal to the requested amount of data (the third parameter). Generally from the incoming stream
resource read. Returns the empty string as the EOF (end of file) signal.
CURLOPT_WRITEFUNCTION
Callback function name. This function should accept two parameters. The first is the cURL resource; the second is the data string to be written. number
The data must be saved within the function. The function must return the exact number of bytes passed in to write the data, otherwise the transfer will be hit by an error.
break.
Return Value Returns TRUE on success, or FALSE on failure. Update Log
Version
Description
5.2.10
Introduced
CURLOPT_PROTOCOLS, and CURLOPT_REDIR_PROTOCOLS.
5.1.0
Introduction
CURLOPT_AUTOREFERER, CURLOPT_BINARYTRANSFER, CURLOPT_FTPSSLAUTH, CURLOPT_PROXYAUTH, and CURLOPT_TIMECONDITION.
5.0.0
Introduction
CURLOPT_FTP_USE_EPRT, CURLOPT_NOSIGNAL, CURLOPT_UNRESTRICTED_AUTH, CURLOPT_BUFFERSIZE, CURLOPT_HTTPAUTH, CURLOPT_PROXYPORT, CURLOPT_PROXYTYPE, CURLOPT_SSLCERTTYPE, and CURLOPT_HTTP200ALIASES.