(PHP 4 >= 4.0.2, PHP 5)
curl_setopt — Set an option for a cURL transfer
Sets an option on the given cURL session handle.
A cURL handle returned by curl_init().
The CURLOPT_XXX option to set.
The value to be set on
valueshould be a bool for the following values of the
TRUEto automatically set the Referer: field in requests where it follows a Location: redirect.
TRUEto return the raw output when
From PHP 5.1.3, this option has no effect: the raw output will always be returned when
TRUEto mark this as a new cookie "session". It will force libcurl to ignore all cookies it is about to load that are "session cookies" from the previous session. By default, libcurl always stores and loads all cookies, independent if they are session cookies or not. Session cookies are cookies without expiry date and they are meant to be alive and existing for this "session" only.
TRUEto output SSL certification information to STDERR on secure transfers.
Added in cURL 7.19.1. Available since PHP 5.3.2. Requires
CURLOPT_VERBOSEto be on to have an effect.
TRUEtells the library to perform all the required proxy authentication and connection setup, but no data transfer. This option is implemented for HTTP, SMTP and POP3.
Added in 7.15.2. Available since PHP 5.5.0.
TRUEto convert Unix newlines to CRLF newlines on transfers.
TRUEto use a global DNS cache. This option is not thread-safe and is enabled by default.
TRUEto fail verbosely if the HTTP code returned is greater than or equal to 400. The default behavior is to return the page normally, ignoring the code.
TRUEto attempt to retrieve the modification date of the remote document. This value can be retrieved using the
CURLINFO_FILETIMEoption with curl_getinfo().
TRUEto follow any "Location: " header that the server sends as part of the HTTP header (note this is recursive, PHP will follow as many "Location: " headers that it is sent, unless
TRUEto force the connection to explicitly close when it has finished processing, and not be pooled for reuse.
TRUEto force the use of a new connection instead of a cached one.
TRUEto use EPRT (and LPRT) when doing active FTP downloads. Use
FALSEto disable EPRT and LPRT and use PORT only.
TRUEto first try an EPSV command for FTP transfers before reverting back to PASV. Set to
FALSEto disable EPSV.
TRUEto create missing directories when an FTP operation encounters a path that currently doesn't exist.
TRUEto append to the remote file instead of overwriting it.
An alias of
CURLOPT_TRANSFERTEXT. Use that instead.
TRUEto only list the names of an FTP directory.
TRUEto include the header in the output.
TRUEto track the handle's request string.
Available since PHP 5.1.3. The
CURLINFO_prefix is intentional.
TRUEto reset the HTTP request method to GET. Since GET is the default, this is only necessary if the request method has been changed.
TRUEto tunnel through a given HTTP proxy.
TRUEto be completely silent with regards to the cURL functions.
Removed in cURL 7.15.5 (You can use CURLOPT_RETURNTRANSFER instead)
TRUEto scan the ~/.netrc file to find a username and password for the remote site that a connection is being established with.
TRUEto exclude the body from the output. Request method is then set to HEAD. Changing this to
FALSEdoes not change it to GET.
TRUEto disable the progress meter for cURL transfers.
PHP automatically sets this option to
TRUE, this should only be changed for debugging purposes.
TRUEto ignore any cURL function that causes a signal to be sent to the PHP process. This is turned on by default in multi-threaded SAPIs so timeout options can still be used.
Added in cURL 7.10.
TRUEto do a regular HTTP POST. This POST is the normal application/x-www-form-urlencoded kind, most commonly used by HTML forms.
TRUEto HTTP PUT a file. The file to PUT must be set with
TRUEto return the transfer as a string of the return value of curl_exec() instead of outputting it out directly.
FALSEto stop cURL from verifying the peer's certificate. Alternate certificates to verify against can be specified with the
CURLOPT_CAINFOoption or a certificate directory can be specified with the
TRUEby default as of cURL 7.10. Default bundle installed as of cURL 7.10.
TRUEto use ASCII mode for FTP transfers. For LDAP, it retrieves data in plain text instead of HTML. On Windows systems, it will not set STDOUT to binary mode.
TRUEto keep sending the username and password when following locations (using
CURLOPT_FOLLOWLOCATION), even when the hostname has changed.
TRUEto prepare for an upload.
TRUEto output verbose information. Writes output to STDERR, or the file specified using
valueshould be an integer for the following values of the
The size of the buffer to use for each read. There is no guarantee this request will be fulfilled, however. Added in cURL 7.10.
CURLCLOSEPOLICY_OLDEST. There are three other CURLCLOSEPOLICY_ constants, but cURL does not support them yet.
The number of seconds to wait while trying to connect. Use 0 to wait indefinitely.
The number of milliseconds to wait while trying to connect. Use 0 to wait indefinitely. If libcurl is built to use the standard system name resolver, that portion of the connect will still use full-second resolution for timeouts with a minimum timeout allowed of one second. Added in cURL 7.16.2. Available since PHP 5.2.3.
The number of seconds to keep DNS entries in memory. This option is set to 120 (2 minutes) by default.
The FTP authentication method (when is activated): CURLFTPAUTH_SSL (try SSL first), CURLFTPAUTH_TLS (try TLS first), or CURLFTPAUTH_DEFAULT (let cURL decide). Added in cURL 7.12.2.
CURL_HTTP_VERSION_NONE(default, lets CURL decide which version to use),
CURL_HTTP_VERSION_1_0(forces HTTP/1.0), or
The HTTP authentication method(s) to use. The options are:
The bitwise | (or) operator can be used to combine more than one method. If this is done, cURL will poll the server to see what methods it supports and pick the best one.
CURLAUTH_ANYis an alias for CURLAUTH_BASIC | CURLAUTH_DIGEST | CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM.
CURLAUTH_ANYSAFEis an alias for CURLAUTH_DIGEST | CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM.
The expected size, in bytes, of the file when uploading a file to a remote site. Note that using this option will not stop libcurl from sending more data, as exactly what is sent depends on
The transfer speed, in bytes per second, that the transfer should be below during the count of
CURLOPT_LOW_SPEED_TIMEseconds before PHP considers the transfer too slow and aborts.
The number of seconds the transfer speed should be below
CURLOPT_LOW_SPEED_LIMITbefore PHP considers the transfer too slow and aborts.
The maximum amount of persistent connections that are allowed. When the limit is reached,
CURLOPT_CLOSEPOLICYis used to determine which connection to close.
The maximum amount of HTTP redirections to follow. Use this option alongside
An alternative port number to connect to.
CURLPROTO_*values. If used, this bitmask limits what protocols libcurl may use in the transfer. This allows you to have a libcurl built to support a wide range of protocols but still limit specific transfers to only be allowed to use a subset of them. By default libcurl will accept all protocols it supports. See also
Valid protocol options are:
Added in cURL 7.19.4.
The HTTP authentication method(s) to use for the proxy connection. Use the same bitmasks as described in
CURLOPT_HTTPAUTH. For proxy authentication, only
CURLAUTH_NTLMare currently supported.
Added in cURL 7.10.7.
The port number of the proxy to connect to. This port number can also be set in
Added in cURL 7.10.
CURLPROTO_*values. If used, this bitmask limits what protocols libcurl may use in a transfer that it follows to in a redirect when
CURLOPT_FOLLOWLOCATIONis enabled. This allows you to limit specific transfers to only be allowed to use a subset of protocols in redirections. By default libcurl will allow all protocols except for FILE and SCP. This is a difference compared to pre-7.19.4 versions which unconditionally would follow to all protocols supported. See also
CURLOPT_PROTOCOLSfor protocol constant values.
Added in cURL 7.19.4.
The offset, in bytes, to resume a transfer from.
1 to check the existence of a common name in the SSL peer certificate. 2 to check the existence of a common name and also verify that it matches the hostname provided. In production environments the value of this option should be kept at 2 (default value). Support for value 1 removed in cURL 7.28.1
The SSL version (2 or 3) to use. By default PHP will try to determine this itself, although in some cases this must be set manually.
CURLOPT_TIMEVALUEis treated. Use
CURL_TIMECOND_IFMODSINCEto return the page only if it has been modified since the time specified in
CURLOPT_TIMEVALUE. If it hasn't been modified, a "304 Not Modified" header will be returned assuming
CURL_TIMECOND_IFUNMODSINCEfor the reverse effect.
CURL_TIMECOND_IFMODSINCEis the default.
The maximum number of seconds to allow cURL functions to execute.
The maximum number of milliseconds to allow cURL functions to execute. If libcurl is built to use the standard system name resolver, that portion of the connect will still use full-second resolution for timeouts with a minimum timeout allowed of one second. Added in cURL 7.16.2. Available since PHP 5.2.3.
The time in seconds since January 1st, 1970. The time will be used by
CURLOPT_TIMECONDITION. By default,
If a download exceeds this speed (counted in bytes per second) on cumulative average during the transfer, the transfer will pause to keep the average rate less than or equal to the parameter value. Defaults to unlimited speed. Added in cURL 7.15.5. Available since PHP 5.4.0.
If an upload exceeds this speed (counted in bytes per second) on cumulative average during the transfer, the transfer will pause to keep the average rate less than or equal to the parameter value. Defaults to unlimited speed. Added in cURL 7.15.5. Available since PHP 5.4.0.
A bitmask consisting of one or more of
CURLSSH_AUTH_KEYBOARD. Set to
CURLSSH_AUTH_ANYto let libcurl pick one.
Added in cURL 7.16.1.
Allows an application to select what kind of IP addresses to use when resolving host names. This is only interesting when using host names that resolve addresses using more than one version of IP, possible values are
CURLOPT_IPRESOLVE_V6, by default
Added in cURL 7.10.8.
valueshould be a string for the following values of the
The name of a file holding one or more certificates to verify the peer with. This only makes sense when used in combination with
Requires absolute path.
A directory that holds multiple CA certificates. Use this option alongside
The contents of the "Cookie: " header to be used in the HTTP request. Note that multiple cookies are separated with a semicolon followed by a space (e.g., "fruit=apple; colour=red")
The name of the file containing the cookie data. The cookie file can be in Netscape format, or just plain HTTP-style headers dumped into a file. If the name is an empty string, no cookies are loaded, but cookie handling is still enabled.
The name of a file to save all internal cookies to when the handle is closed, e.g. after a call to curl_close.
A custom request method to use instead of "GET" or "HEAD" when doing a HTTP request. This is useful for doing "DELETE" or other, more obscure HTTP requests. Valid values are things like "GET", "POST", "CONNECT" and so on; i.e. Do not enter a whole HTTP request line here. For instance, entering "GET /index.html HTTP/1.0\r\n\r\n" would be incorrect.
Don't do this without making sure the server supports the custom request method first.
CURLOPT_RANDOM_FILE, except a filename to an Entropy Gathering Daemon socket.
The contents of the "Accept-Encoding: " header. This enables decoding of the response. Supported encodings are "identity", "deflate", and "gzip". If an empty string, "", is set, a header containing all supported encoding types is sent. Added in cURL 7.10.
The value which will be used to get the IP address to use for the FTP "POST" instruction. The "POST" 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 systems default IP address.
The name of the outgoing network interface to use. This can be an interface name, an IP address or a host name.
The password required to use the
Added in cURL 7.16.1.
The KRB4 (Kerberos 4) security level. Any of the following 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
NULLwill disable KRB4 security. Currently KRB4 security only works with FTP transactions.
The full data to post in a HTTP "POST" operation. To post a file, prepend a filename with @ and use the full path. The filetype can be explicitly specified by following the filename with the type in the format ';type=mimetype'. 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
valueis an array, the Content-Type header will be set to multipart/form-data. As of PHP 5.2.0,
valuemust be an array if files are passed to this option with the @ prefix. As of PHP 5.5.0, the @ prefix is deprecated and files can be sent using CURLFile.
The HTTP proxy to tunnel requests through.
A username and password formatted as "[username]:[password]" to use for the connection to the proxy.
A filename to be used to seed the random number generator for SSL.
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".
The contents of the "Referer: " header to be used in a HTTP request.
A string containing 32 hexadecimal digits. The string should be the MD5 checksum of the remote host's public key, and libcurl will reject the connection to the host unless the md5sums match. This option is only for SCP and SFTP transfers. Added in 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.
A list of ciphers to use for SSL. For example, RC4-SHA and TLSv1 are valid cipher lists.
The name of a file containing a PEM formatted certificate.
The password required to use the
The format of the certificate. Supported formats are "PEM" (default), "DER", and "ENG". Added in cURL 7.9.3.
The identifier for the crypto engine of the private SSL key specified in
The identifier for the crypto engine used for asymmetric crypto operations.
The name of a file containing a private SSL key.
The secret password needed to use the private SSL key specified in
Since this option contains a sensitive password, remember to keep the PHP script it is contained within safe.
The key type of the private SSL key specified in
CURLOPT_SSLKEY. Supported key types are "PEM" (default), "DER", and "ENG".
The URL to fetch. This can also be set when initializing a session with curl_init().
The contents of the "User-Agent: " header to be used in a HTTP request.
A username and password formatted as "[username]:[password]" to use for the connection.
valueshould be an array for the following values of the
An array of HTTP 200 responses that will be treated as valid responses and not as errors. Added in cURL 7.10.3.
An array of HTTP header fields to set, in the format
array('Content-type: text/plain', 'Content-length: 100')
An array of FTP commands to execute on the server after the FTP request has been performed.
An array of FTP commands to execute on the server prior to the FTP request.
valueshould be a stream resource (using fopen(), for example) for the following values of the
The file that the transfer should be written to. The default is STDOUT (the browser window).
The file that the transfer should be read from when uploading.
An alternative location to output errors to instead of STDERR.
The file that the header part of the transfer is written to.
valueshould be the name of a valid function or a Closure for the following values of the
A callback accepting two parameters. The first is the cURL resource, the second is a string with the header data to be written. The header data must be written when by this callback. Return the number of bytes written.
A callback accepting three parameters. The first is the cURL resource, the second is a string containing a password prompt, and the third is the maximum password length. Return the string containing the password.
A callback accepting five parameters. The first is the cURL resource, the second is the total number of bytes expected to be downloaded in this transfer, the third is the number of bytes downloaded so far, the fourth is the total number of bytes expected to be uploaded in this transfer, and the fifth is the number of bytes uploaded so far.
The callback is only called when the
CURLOPT_NOPROGRESSoption is set to
Return a non-zero value to abort the transfer. In which case, the transfer will set a
A callback accepting three parameters. The first is the cURL resource, the second is a stream resource provided to cURL through the option
CURLOPT_INFILE, and the third is the maximum amount of data to be read. The callback must 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.
A callback accepting two parameters. The first is the cURL resource, and the second is a string with the data to be written. The data must be saved by this callback. It must return the exact number of bytes written or the transfer will be aborted with an error.
A result of curl_share_init(). Makes the cURL handle to use the data from the shared handle.
TRUE on success or
FALSE on failure.
|5.5.0|| Added the cURL resource as the first argument to the |
|5.5.0|| Introduced |
|5.3.0|| Introduced |
|5.2.10|| Introduced |
|5.1.0|| Introduced |
|5.0.0|| Introduced |
Example #1 Initializing a new cURL session and fetching a web page
// create a new cURL resource
$ch = curl_init();
// set URL and other appropriate options
curl_setopt($ch, CURLOPT_URL, "http://www.example.com/");
curl_setopt($ch, CURLOPT_HEADER, false);
// grab URL and pass it to the browser
// close cURL resource, and free up system resources
Example #2 Uploading file
$ch = curl_init();
$data = array('name' => 'Foo', 'file' => '@/home/user/test.png');
curl_setopt($ch, CURLOPT_URL, 'http://localhost/upload.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
The above example will output:
Array ( [name] => Foo ) Array ( [file] => Array ( [name] => test.png [type] => image/png [tmp_name] => /tmp/phpcpjNeQ [error] => 0 [size] => 279 ) )
Passing an array to
CURLOPT_POSTFIELDSwill encode the data as multipart/form-data, while passing a URL-encoded string will encode the data as application/x-www-form-urlencoded.
- curl_setopt_array() - Set multiple options for a cURL transfer