The constants below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
Constants |
Description |
curl-setopt()
CURLOPT_ABSTRACT_UNIX_SOCKET
(int)
|
Enables the use of an abstract Unix domain socket instead of
establishing a TCP connection to a host and sets the path to
the given string. This option shares the same semantics
as CURLOPT_UNIX_SOCKET_PATH . These two options
share the same storage and therefore only one of them can be set
per handle.
Available as of PHP 7.3.0 and cURL 7.53.0
|
CURLOPT_ALTSVC
(int)
|
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 .
Available as of PHP 8.2.0 and cURL 7.64.1.
|
CURLOPT_ALTSVC_CTRL
(int)
|
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 .
Available as of PHP 8.2.0 and cURL 7.64.1.
|
CURLOPT_AUTOREFERER
(int)
|
true to automatically set the Referer: field in
requests where it follows a Location: redirect.
|
CURLOPT_AWS_SIGV4
(int)
|
Provides AWS V4 signature authentication on HTTP(S) header.
This option overrides any other authentication types that have been set in
CURLOPT_HTTPAUTH . This method cannot be combined with other authentication types.
Available as of PHP 8.2.0 and cURL 7.75.0
|
CURLOPT_BINARYTRANSFER
(int)
|
|
CURLOPT_BUFFERSIZE
(int)
|
The size of the buffer to use for each read. There is no guarantee
this request will be fulfilled, however.
Available as of cURL 7.10.
|
CURLOPT_CAINFO
(int)
|
The name of a file holding one or more certificates to verify the
peer with. This only makes sense when used in combination with
CURLOPT_SSL_VERIFYPEER . Might require an absolute path.
|
CURLOPT_CAINFO_BLOB
(int)
|
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
(int)
|
A directory that holds multiple CA certificates. Use this option
alongside CURLOPT_SSL_VERIFYPEER .
|
CURLOPT_CA_CACHE_TIMEOUT
(int)
|
Available as of PHP 8.3.0 and cURL 7.87.0
|
CURLOPT_CERTINFO
(int)
|
true to output SSL certification information to STDERR
on secure transfers. Added in cURL 7.19.1.
Requires CURLOPT_VERBOSE to be on to have an effect.
|
CURLOPT_CONNECTTIMEOUT
(int)
|
The number of seconds to wait while trying to connect. Use 0 to
wait indefinitely.
|
CURLOPT_CONNECTTIMEOUT_MS
(int)
|
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. Available as of cURL 7.16.2.
|
CURLOPT_CONNECT_ONLY
(int)
|
true tells 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.
Available as of cURL 7.15.2.
|
CURLOPT_CONNECT_TO
(int)
|
Connect to a specific host and port instead of the URL's host and port.
Accepts an array of strings with the format
HOST:PORT:CONNECT-TO-HOST:CONNECT-TO-PORT .
Available as of PHP 7.0.7 and cURL 7.49.0
|
CURLOPT_COOKIE
(int)
|
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 ")
|
CURLOPT_COOKIEFILE
(int)
|
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.
|
CURLOPT_COOKIEJAR
(int)
|
The name of a file to save all internal cookies to when the
handle's destructor is called.
Warning
As of PHP 8.0.0, curl_close() is a no-op
and does not destroy the handle.
If cookies need to be written prior to the handle being automatically
destroyed, call unset() on the handle.
|
CURLOPT_COOKIELIST
(int)
|
A cookie string (i.e. a single line in Netscape/Mozilla format, or a regular
HTTP-style Set-Cookie header) adds that single cookie to the internal cookie store.
"ALL" erases all cookies held in memory.
"SESS" erases all session cookies held in memory.
"FLUSH" writes all known cookies to the file specified by CURLOPT_COOKIEJAR .
"RELOAD" loads all cookies from the files specified by CURLOPT_COOKIEFILE .
Available as of cURL 7.14.1
|
CURLOPT_COOKIESESSION
(int)
|
true to 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.
|
CURLOPT_CRLF
(int)
|
true to convert Unix newlines to CRLF newlines
on transfers.
|
CURLOPT_CUSTOMREQUEST
(int)
|
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.
Note:
Don't do this without making sure the server supports the custom
request method first.
|
CURLOPT_DEFAULT_PROTOCOL
(int)
|
The default protocol to use if the URL is missing a scheme name.
Available as of PHP 7.0.7 and cURL 7.45.0
|
CURLOPT_DISALLOW_USERNAME_IN_URL
(int)
|
true to not allow URLs that include a username. Usernames are allowed by default (0).
Available as of PHP 7.3.0 and cURL 7.61.0
|
CURLOPT_DNS_CACHE_TIMEOUT
(int)
|
The number of seconds to keep DNS entries in memory. This
option is set to 120 (2 minutes) by default.
|
CURLOPT_DNS_INTERFACE
(int)
|
Set the name of the network interface that the DNS resolver should bind to.
This must be an interface name (not an address).
Available as of PHP 7.0.7 and cURL 7.33.0
|
CURLOPT_DNS_LOCAL_IP4
(int)
|
Set the local IPv4 address that the resolver should bind to. The argument
should contain a single numerical IPv4 address as a string.
Available as of PHP 7.0.7 and cURL 7.33.0
|
CURLOPT_DNS_LOCAL_IP6
(int)
|
Set the local IPv6 address that the resolver should bind to. The argument
should contain a single numerical IPv6 address as a string.
Available as of PHP 7.0.7 and cURL 7.33.0
|
CURLOPT_DNS_SHUFFLE_ADDRESSES
(int)
|
true to shuffle the order of all returned addresses so that they will be used
in a random order, when a name is resolved and more than one IP address is returned.
This may cause IPv4 to be used before IPv6 or vice versa.
Available as of PHP 7.3.0 and cURL 7.60.0
|
CURLOPT_DNS_USE_GLOBAL_CACHE
(int)
|
true to use a global DNS cache. This option is not thread-safe.
It is conditionally enabled by default if PHP is built for non-threaded use
(CLI, FCGI, Apache2-Prefork, etc.).
|
CURLOPT_DOH_SSL_VERIFYHOST
(int)
|
Verify the DNS-over-HTTPS server's SSL certificate name fields against the host name.
Available as of PHP 8.2.0 and cURL 7.76.0.
|
CURLOPT_DOH_SSL_VERIFYPEER
(int)
|
Verify the authenticity of the DNS-over-HTTPS server's SSL certificate.
Available as of PHP 8.2.0 and cURL 7.76.0.
|
CURLOPT_DOH_SSL_VERIFYSTATUS
(int)
|
Tell cURL to verify the status of the DNS-over-HTTPS server certificate
using the "Certificate Status Request" TLS extension (OCSP stapling).
Available as of PHP 8.2.0 and cURL 7.76.0.
|
CURLOPT_DOH_URL
(int)
|
Provides the DNS-over-HTTPS URL.
Available as of PHP 8.1.0 and cURL 7.62.0.
|
CURLOPT_EGDSOCKET
(int)
|
Like CURLOPT_RANDOM_FILE , except a filename
to an Entropy Gathering Daemon socket.
|
CURLOPT_ENCODING
(int)
|
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.
Available as of cURL 7.10.
|
CURLOPT_EXPECT_100_TIMEOUT_MS
(int)
|
The timeout for Expect: 100-continue responses in milliseconds.
Defaults to 1000 milliseconds.
Available as of PHP 7.0.7 and cURL 7.36.0
|
CURLOPT_FAILONERROR
(int)
|
true to 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.
|
CURLOPT_FILE
(int)
|
The file that the transfer should be written to. The default
is STDOUT (the browser window).
|
CURLOPT_FILETIME
(int)
|
true to attempt to retrieve the modification
date of the remote document. This value can be retrieved using
the CURLINFO_FILETIME option with
curl_getinfo().
|
CURLOPT_FOLLOWLOCATION
(int)
|
true to follow any
"Location: " header that the server sends as
part of the HTTP header.
See also CURLOPT_MAXREDIRS .
This constant is not available when open_basedir
is enabled.
|
CURLOPT_FORBID_REUSE
(int)
|
true to force the connection to explicitly
close when it has finished processing, and not be pooled for reuse.
|
CURLOPT_FRESH_CONNECT
(int)
|
true to force the use of a new connection
instead of a cached one.
|
CURLOPT_FTPAPPEND
(int)
|
true to append to the remote file instead of
overwriting it.
|
CURLOPT_FTPASCII
(int)
|
An alias of
CURLOPT_TRANSFERTEXT . Use that instead.
|
CURLOPT_FTPLISTONLY
(int)
|
true to only list the names of an FTP
directory.
|
CURLOPT_FTPPORT
(int)
|
The value which will be used to get the IP address to use
for the FTP "PORT" instruction. The "PORT" 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.
|
CURLOPT_FTPSSLAUTH
(int)
|
The FTP authentication method (when is activated):
CURLFTPAUTH_SSL (try SSL first),
CURLFTPAUTH_TLS (try TLS first), or
CURLFTPAUTH_DEFAULT (let cURL decide).
Available as of cURL 7.12.2.
|
CURLOPT_FTP_CREATE_MISSING_DIRS
(int)
|
true to create missing directories when an FTP operation
encounters a path that currently doesn't exist.
|
CURLOPT_FTP_FILEMETHOD
(int)
|
Tell curl which method to use to reach a file on a FTP(S) server. Possible values are
CURLFTPMETHOD_DEFAULT ,
CURLFTPMETHOD_MULTICWD ,
CURLFTPMETHOD_NOCWD , and
CURLFTPMETHOD_SINGLECWD .
Available as of cURL 7.15.1.
|
CURLOPT_FTP_SSL
(int)
|
|
CURLOPT_FTP_USE_EPRT
(int)
|
true to use EPRT (and LPRT) when doing active
FTP downloads. Use false to disable EPRT and LPRT and use PORT
only.
|
CURLOPT_FTP_USE_EPSV
(int)
|
true to first try an EPSV command for FTP
transfers before reverting back to PASV. Set to false
to disable EPSV.
|
CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS
(int)
|
Head start for ipv6 for the happy eyeballs algorithm. Happy eyeballs attempts
to connect to both IPv4 and IPv6 addresses for dual-stack hosts,
preferring IPv6 first for timeout milliseconds.
Defaults to CURL_HET_DEFAULT, which is currently 200 milliseconds.
Available as of PHP 7.3.0 and cURL 7.59.0
|
CURLOPT_HAPROXYPROTOCOL
(int)
|
true to send an HAProxy PROXY protocol v1 header at the start of the connection.
The default action is not to send this header.
Available as of PHP 7.3.0 and cURL 7.60.0
|
true to include the header in the output.
|
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 by this callback. Return the number of
bytes written.
|
Possible values are CURLHEADER_UNIFIED or CURLHEADER_SEPARATE .
Defaults to CURLHEADER_SEPARATE as of cURL
7.42.1, and CURLHEADER_UNIFIED before.
Available as of PHP 7.0.7 and cURL 7.37.0
|
CURLOPT_HSTS
(int)
|
HSTS (HTTP Strict Transport Security) cache file name.
Available as of PHP 8.2.0 and cURL 7.74.0
|
CURLOPT_HSTS_CTRL
(int)
|
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.
CURLHSTS_ENABLE enables the in-memory HSTS cache. If the HSTS cache file is defined,
set CURLHSTS_READONLYFILE to make the file read-only.
Available as of PHP 8.2.0 and cURL 7.74.0
|
CURLOPT_HTTP09_ALLOWED
(int)
|
Whether to allow HTTP/0.9 responses. Defaults to false as of libcurl 7.66.0;
formerly it defaulted to true .
Available as of PHP 7.3.15 and 7.4.3, respectively, and cURL 7.64.0
|
CURLOPT_HTTP200ALIASES
(int)
|
An array of HTTP 200 responses that will be treated as valid
responses and not as errors.
Available as of cURL 7.10.3.
|
CURLOPT_HTTPAUTH
(int)
|
The HTTP authentication method(s) to use. The options are:
CURLAUTH_BASIC ,
CURLAUTH_DIGEST ,
CURLAUTH_GSSNEGOTIATE ,
CURLAUTH_NTLM ,
CURLAUTH_AWS_SIGV4 ,
CURLAUTH_ANY , and
CURLAUTH_ANYSAFE .
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_ANY sets all bits. cURL will automatically select
the one it finds most secure.
CURLAUTH_ANYSAFE sets all bits except CURLAUTH_BASIC .
cURL will automatically select the one it finds most secure.
|
CURLOPT_HTTPGET
(int)
|
true to reset the HTTP request method to GET.
Since GET is the default, this is only necessary if the request
method has been changed.
|
An array of HTTP header fields to set, in the format
array('Content-type: text/plain', 'Content-length: 100')
|
CURLOPT_HTTPPROXYTUNNEL
(int)
|
true to tunnel through a given HTTP proxy.
|
CURLOPT_HTTP_CONTENT_DECODING
(int)
|
false to get the raw HTTP response body.
Available as of cURL 7.16.2.
|
CURLOPT_HTTP_VERSION
(int)
|
CURL_HTTP_VERSION_NONE (default, lets CURL
decide which version to use),
CURL_HTTP_VERSION_1_0 (forces HTTP/1.0),
CURL_HTTP_VERSION_1_1 (forces HTTP/1.1),
CURL_HTTP_VERSION_2_0 (attempts HTTP 2),
CURL_HTTP_VERSION_2 (alias of CURL_HTTP_VERSION_2_0 ),
CURL_HTTP_VERSION_2TLS (attempts HTTP 2 over TLS (HTTPS) only) or
CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE (issues non-TLS HTTP requests using HTTP/2 without HTTP/1.1 Upgrade).
|
CURLOPT_INFILE
(int)
|
The file that the transfer should be read from when uploading.
|
CURLOPT_INFILESIZE
(int)
|
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
CURLOPT_READFUNCTION .
|
CURLOPT_INTERFACE
(int)
|
The name of the outgoing network interface to use. This can be an
interface name, an IP address or a host name.
|
CURLOPT_IPRESOLVE
(int)
|
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
CURL_IPRESOLVE_WHATEVER ,
CURL_IPRESOLVE_V4 ,
CURL_IPRESOLVE_V6 , by default
CURL_IPRESOLVE_WHATEVER .
Available as of cURL 7.10.8.
|
CURLOPT_ISSUERCERT_BLOB
(int)
|
Issuer SSL certificate from memory blob.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_KEEP_SENDING_ON_ERROR
(int)
|
true to keep sending the request body if the HTTP code returned is
equal to or larger than 300. The default action would be to stop sending
and close the stream or connection. Suitable for manual NTLM authentication.
Most applications do not need this option.
Available as of PHP 7.3.0 and cURL 7.51.0
|
CURLOPT_KEYPASSWD
(int)
|
The password required to use the CURLOPT_SSLKEY
or CURLOPT_SSH_PRIVATE_KEYFILE private key.
Available as of cURL 7.16.1.
|
CURLOPT_KRB4LEVEL
(int)
|
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 null
will disable KRB4 security. Currently KRB4 security only works
with FTP transactions.
|
CURLOPT_LOGIN_OPTIONS
(int)
|
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.
Available as of PHP 7.0.7 and cURL 7.34.0
|
CURLOPT_LOW_SPEED_LIMIT
(int)
|
The transfer speed, in bytes per second, that the transfer should be
below during the count of CURLOPT_LOW_SPEED_TIME
seconds before PHP considers the transfer too slow and aborts.
|
CURLOPT_LOW_SPEED_TIME
(int)
|
The number of seconds the transfer speed should be below
CURLOPT_LOW_SPEED_LIMIT before PHP considers
the transfer too slow and aborts.
|
CURLOPT_MAIL_RCPT_ALLLOWFAILS
(int)
|
Available as of PHP 8.2.0 and cURL 7.69.0
|
CURLOPT_MAXAGE_CONN
(int)
|
The maximum idle time allowed for an existing connection to be considered for reuse.
Default maximum age is set to 118 seconds.
Available as of PHP 8.2.0 and cURL 7.65.0
|
CURLOPT_MAXCONNECTS
(int)
|
The maximum amount of persistent connections that are allowed.
When the limit is reached, the oldest one in the cache is closed
to prevent increasing the number of open connections.
|
CURLOPT_MAXFILESIZE_LARGE
(int)
|
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.
Available as of PHP 8.2.0 and cURL 7.11.0
|
CURLOPT_MAXLIFETIME_CONN
(int)
|
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.
Available as of PHP 8.2.0 and cURL 7.80.0
|
CURLOPT_MAXREDIRS
(int)
|
The maximum amount of HTTP redirections to follow. Use this option
alongside CURLOPT_FOLLOWLOCATION .
Default value of 20 is set to prevent infinite redirects.
Setting to -1 allows inifinite redirects, and 0
refuses all redirects.
|
CURLOPT_MAX_RECV_SPEED_LARGE
(int)
|
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.
Available as of cURL 7.15.5
|
CURLOPT_MAX_SEND_SPEED_LARGE
(int)
|
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.
Available as of cURL 7.15.5
|
CURLOPT_MIME_OPTIONS
(int)
|
Available as of PHP 8.3.0 and cURL 7.81.0
|
CURLOPT_MUTE
(int)
|
true to be completely silent with regards to
the cURL functions.
Removed as of cURL 7.15.5; use CURLOPT_RETURNTRANSFER instead.
|
CURLOPT_NETRC
(int)
|
true to scan the ~/.netrc
file to find a username and password for the remote site that
a connection is being established with.
|
CURLOPT_NOBODY
(int)
|
true to exclude the body from the output.
Request method is then set to HEAD. Changing this to false does
not change it to GET.
|
CURLOPT_NOPROGRESS
(int)
|
true to disable the progress meter for cURL transfers.
Note:
PHP automatically sets this option to true , this should only be
changed for debugging purposes.
|
CURLOPT_NOSIGNAL
(int)
|
true to 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.
Available as of cURL 7.10.
|
CURLOPT_PASSWDFUNCTION
(int)
|
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.
Removed as of PHP 7.3.0.
|
CURLOPT_PASSWORD
(int)
|
The password to use in authentication.
Available as of cURL 7.19.1.
|
CURLOPT_PATH_AS_IS
(int)
|
true to not handle dot dot sequences.
Available as of PHP 7.0.7 and cURL 7.42.0
|
CURLOPT_PINNEDPUBLICKEY
(int)
|
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 ";".
Available as of PHP 7.0.7 and cURL 7.39.0
|
CURLOPT_PIPEWAIT
(int)
|
true to wait for pipelining/multiplexing.
Available as of PHP 7.0.7 and cURL 7.43.0
|
CURLOPT_PORT
(int)
|
An alternative port number to connect to.
|
CURLOPT_POST
(int)
|
true to do a regular HTTP POST. This POST is the
normal application/x-www-form-urlencoded kind,
most commonly used by HTML forms.
|
CURLOPT_POSTFIELDS
(int)
|
The full data to post in a HTTP "POST" operation.
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 value is an array, the
Content-Type header will be set to
multipart/form-data .
Files can be sent using CURLFile or CURLStringFile,
in which case value must be an array.
|
CURLOPT_POSTQUOTE
(int)
|
An array of FTP commands to execute on the server after the FTP
request has been performed.
|
CURLOPT_POSTREDIR
(int)
|
A bitmask of 1 (301 Moved Permanently), 2 (302 Found)
and 4 (303 See Other) if the HTTP POST method should be maintained
when CURLOPT_FOLLOWLOCATION is set and a
specific type of redirect occurs.
Available as of cURL 7.19.1.
|
CURLOPT_PRE_PROXY
(int)
|
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.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PRIVATE
(int)
|
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.
Available as of cURL 7.10.3.
|
CURLOPT_PROGRESSFUNCTION
(int)
|
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.
Note:
The callback is only called when the CURLOPT_NOPROGRESS
option is set to false .
Return a non-zero value to abort the transfer. In which case, the
transfer will set a CURLE_ABORTED_BY_CALLBACK
error.
|
CURLOPT_PROTOCOLS
(int)
|
Bitmask of 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 CURLOPT_REDIR_PROTOCOLS .
Valid 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_TFTP ,
CURLPROTO_MQTT ,
CURLPROTO_ALL
Available as of cURL 7.19.4.
|
CURLOPT_PROTOCOLS_STR
(int)
|
Available as of PHP 8.3.0 and cURL 7.85.0
|
CURLOPT_PROXY
(int)
|
The HTTP proxy to tunnel requests through.
|
CURLOPT_PROXYAUTH
(int)
|
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_BASIC and
CURLAUTH_NTLM are currently supported.
Available as of cURL 7.10.7.
|
An array of custom HTTP headers to pass to proxies.
Available as of PHP 7.0.7 and cURL 7.37.0
|
CURLOPT_PROXYPORT
(int)
|
The port number of the proxy to connect to. This port number can
also be set in CURLOPT_PROXY .
|
CURLOPT_PROXYTYPE
(int)
|
Either CURLPROXY_HTTP (default),
CURLPROXY_SOCKS4 ,
CURLPROXY_SOCKS5 ,
CURLPROXY_SOCKS4A or
CURLPROXY_SOCKS5_HOSTNAME .
Available as of cURL 7.10.
|
CURLOPT_PROXYUSERPWD
(int)
|
A username and password formatted as
"[username]:[password]" to use for the
connection to the proxy.
|
CURLOPT_PROXY_CAINFO
(int)
|
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.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_CAINFO_BLOB
(int)
|
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 cURL 7.77.0
|
CURLOPT_PROXY_CAPATH
(int)
|
The directory holding multiple CA certificates to verify the HTTPS proxy with.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_CRLFILE
(int)
|
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.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_ISSUERCERT
(int)
|
Proxy issuer SSL certificate filename.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_PROXY_ISSUERCERT_BLOB
(int)
|
Proxy issuer SSL certificate from memory blob.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_PROXY_KEYPASSWD
(int)
|
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.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_PINNEDPUBLICKEY
(int)
|
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 ";".
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_SERVICE_NAME
(int)
|
The proxy authentication service name.
Available as of PHP 7.0.7, cURL 7.43.0 (for HTTP proxies) and cURL 7.49.0 (for SOCKS5 proxies).
|
CURLOPT_PROXY_SSLCERT
(int)
|
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.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_SSLCERTTYPE
(int)
|
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".
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_SSLCERT_BLOB
(int)
|
SSL proxy client certificate from memory blob.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_PROXY_SSLKEY
(int)
|
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. Available if built TLS enabled.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_SSLKEYTYPE
(int)
|
The format of your private key. Supported formats are "PEM", "DER" and "ENG".
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_SSLKEY_BLOB
(int)
|
Private key for proxy cert from memory blob.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_PROXY_SSLVERSION
(int)
|
One of
CURL_SSLVERSION_DEFAULT , CURL_SSLVERSION_TLSv1 , CURL_SSLVERSION_TLSv1_0 , CURL_SSLVERSION_TLSv1_1 , CURL_SSLVERSION_TLSv1_2 , CURL_SSLVERSION_TLSv1_3 , CURL_SSLVERSION_MAX_DEFAULT , CURL_SSLVERSION_MAX_TLSv1_0 , CURL_SSLVERSION_MAX_TLSv1_1 , CURL_SSLVERSION_MAX_TLSv1_2 , CURL_SSLVERSION_MAX_TLSv1_3 , CURL_SSLVERSION_SSLv3
.
Warning
It is better to not set this option and leave the default
CURL_SSLVERSION_DEFAULT
which will attempt to figure out the remote SSL protocol version.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_SSL_CIPHER_LIST
(int)
|
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.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_SSL_OPTIONS
(int)
|
Set proxy SSL behavior options, which is a bitmask of the following constants:
CURLSSLOPT_ALLOW_BEAST , CURLSSLOPT_NO_REVOKE , CURLSSLOPT_NO_PARTIALCHAIN
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_SSL_VERIFYHOST
(int)
|
Set to 2 to verify in the HTTPS proxy's certificate name fields against the proxy name.
When set to 0 the connection succeeds regardless of the names used in the certificate.
Use that ability with caution!
1 treated as a debug option in curl 7.28.0 and earlier.
From curl 7.28.1 to 7.65.3 CURLE_BAD_FUNCTION_ARGUMENT is returned.
From curl 7.66.0 onwards 1 and 2 is treated as the same value.
In production environments the value of this option should be kept at 2 (default value).
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_SSL_VERIFYPEER
(int)
|
false to stop cURL from verifying the peer's certificate.
Alternate certificates to verify against can be
specified with the CURLOPT_CAINFO option
or a certificate directory can be specified with the
CURLOPT_CAPATH option.
When set to false, the peer certificate verification succeeds regardless. true by default.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_TLS13_CIPHERS
(int)
|
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. Available when built with OpenSSL >= 1.1.1.
Available as of PHP 7.3.0 and cURL 7.61.0
|
CURLOPT_PROXY_TLSAUTH_PASSWORD
(int)
|
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.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_TLSAUTH_TYPE
(int)
|
The method of the TLS authentication used for the HTTPS connection.
Supported method is "SRP" .
Note:
Secure Remote Password (SRP) authentication for TLS provides mutual authentication
if both sides have a shared secret. To use TLS-SRP, you must also set the
CURLOPT_PROXY_TLSAUTH_USERNAME and
CURLOPT_PROXY_TLSAUTH_PASSWORD options.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PROXY_TLSAUTH_USERNAME
(int)
|
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.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLOPT_PUT
(int)
|
true to HTTP PUT a file. The file to PUT must
be set with CURLOPT_INFILE and
CURLOPT_INFILESIZE .
|
CURLOPT_QUICK_EXIT
(int)
|
Available as of PHP 8.3.0 and cURL 7.87.0
|
CURLOPT_QUOTE
(int)
|
An array of FTP commands to execute on the server prior to the FTP
request.
|
CURLOPT_RANDOM_FILE
(int)
|
A filename to be used to seed the random number generator for SSL.
|
CURLOPT_RANGE
(int)
|
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" .
|
CURLOPT_READFUNCTION
(int)
|
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 .
|
CURLOPT_REDIR_PROTOCOLS
(int)
|
Bitmask of CURLPROTO_* values. If used, this bitmask
limits what protocols libcurl may use in a transfer that it follows to in
a redirect when CURLOPT_FOLLOWLOCATION is 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_PROTOCOLS for protocol constant values.
Available as of cURL 7.19.4.
|
CURLOPT_REDIR_PROTOCOLS_STR
(int)
|
Available as of PHP 8.3.0 and cURL 7.85.0.
|
CURLOPT_REFERER
(int)
|
The contents of the "Referer: " header to be used
in a HTTP request.
|
CURLOPT_REQUEST_TARGET
(int)
|
Available as of PHP 7.3.0 and cURL 7.55.0.
|
CURLOPT_RESOLVE
(int)
|
Provide a custom address for a specific host and port pair. An array
of hostname, port, and IP address strings, each element separated by
a colon. In the format:
array("example.com:80:127.0.0.1")
Available as of cURL 7.21.3.
|
CURLOPT_RESUME_FROM
(int)
|
The offset, in bytes, to resume a transfer from.
|
CURLOPT_RETURNTRANSFER
(int)
|
true to return the transfer as a string of the
return value of curl_exec() instead of outputting
it directly.
|
CURLOPT_SAFE_UPLOAD
(int)
|
Always true , what disables support for the @ prefix for
uploading files in CURLOPT_POSTFIELDS , which
means that values starting with @ can be safely
passed as fields. CURLFile may be used for
uploads instead.
|
CURLOPT_SASL_AUTHZID
(int)
|
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.
Available as of PHP 8.2.0 and cURL 7.66.0
|
CURLOPT_SASL_IR
(int)
|
true to enable sending the initial response in the first packet.
Available as of PHP 7.0.7 and cURL 7.31.0
|
CURLOPT_SERVICE_NAME
(int)
|
The authentication service name.
Available as of PHP 7.0.7 and cURL 7.43.0
|
CURLOPT_SHARE
(int)
|
A result of curl_share_init(). Makes the cURL
handle to use the data from the shared handle.
|
CURLOPT_SOCKS5_AUTH
(int)
|
The SOCKS5 authentication method(s) to use. The options are:
CURLAUTH_BASIC ,
CURLAUTH_GSSAPI ,
CURLAUTH_NONE .
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_BASIC allows username/password authentication.
CURLAUTH_GSSAPI allows GSS-API authentication.
CURLAUTH_NONE allows no authentication.
Defaults to CURLAUTH_BASIC|CURLAUTH_GSSAPI .
Set the actual username and password with the CURLOPT_PROXYUSERPWD option.
Available as of PHP 7.3.0 and cURL 7.55.0
|
CURLOPT_SSH_AUTH_TYPES
(int)
|
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.
Available as of cURL 7.16.1.
|
CURLOPT_SSH_COMPRESSION
(int)
|
true to enable built-in SSH compression. This is a request, not an order;
the server may or may not do it.
Available as of PHP 7.3.0 and cURL 7.56.0
|
CURLOPT_SSH_HOSTKEYFUNCTION
(int)
|
Available as of PHP 8.3.0 and cURL 7.84.0
|
CURLOPT_SSH_HOST_PUBLIC_KEY_MD5
(int)
|
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.
Available as of cURL 7.17.1.
|
CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256
(int)
|
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.
Available as of PHP 8.2.0 and cURL 7.80.0
|
CURLOPT_SSH_PRIVATE_KEYFILE
(int)
|
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 .
Available as of cURL 7.16.1.
|
CURLOPT_SSH_PUBLIC_KEYFILE
(int)
|
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.
Available as of cURL 7.16.1.
|
CURLOPT_SSLCERT
(int)
|
The name of a file containing a PEM formatted certificate.
|
CURLOPT_SSLCERTPASSWD
(int)
|
The password required to use the
CURLOPT_SSLCERT certificate.
|
CURLOPT_SSLCERTTYPE
(int)
|
The format of the certificate. Supported formats are
"PEM" (default), "DER" ,
and "ENG" .
As of OpenSSL 0.9.3, "P12" (for PKCS#12-encoded files)
is also supported.
Available as of cURL 7.9.3.
|
CURLOPT_SSLCERT_BLOB
(int)
|
SSL client certificate from memory blob.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_SSLENGINE
(int)
|
The identifier for the crypto engine of the private SSL key
specified in CURLOPT_SSLKEY .
|
CURLOPT_SSLENGINE_DEFAULT
(int)
|
The identifier for the crypto engine used for asymmetric crypto
operations.
|
CURLOPT_SSLKEY
(int)
|
The name of a file containing a private SSL key.
|
CURLOPT_SSLKEYPASSWD
(int)
|
The secret password needed to use the private SSL key specified in
CURLOPT_SSLKEY .
Note:
Since this option contains a sensitive password, remember to keep
the PHP script it is contained within safe.
|
CURLOPT_SSLKEYTYPE
(int)
|
The key type of the private SSL key specified in
CURLOPT_SSLKEY . Supported key types are
"PEM" (default), "DER" ,
and "ENG" .
|
CURLOPT_SSLKEY_BLOB
(int)
|
Private key for client cert from memory blob.
Available as of PHP 8.1.0 and cURL 7.71.0.
|
CURLOPT_SSLVERSION
(int)
|
One of
CURL_SSLVERSION_DEFAULT , CURL_SSLVERSION_TLSv1 , CURL_SSLVERSION_SSLv2 , CURL_SSLVERSION_SSLv3 , CURL_SSLVERSION_TLSv1_0 , CURL_SSLVERSION_TLSv1_1 , CURL_SSLVERSION_TLSv1_2 , CURL_SSLVERSION_TLSv1_3
.
The maximum TLS version can be set by using one of the
CURL_SSLVERSION_MAX_*
constants.
It is also possible to bitwise OR one of the
CURL_SSLVERSION_*
constants with one of the
CURL_SSLVERSION_MAX_* .
CURL_SSLVERSION_MAX_DEFAULT (the maximum version supported by the library), CURL_SSLVERSION_MAX_TLSv1_0 , CURL_SSLVERSION_MAX_TLSv1_1 , CURL_SSLVERSION_MAX_TLSv1_2 , CURL_SSLVERSION_MAX_TLSv1_3
.
|
CURLOPT_SSL_CIPHER_LIST
(int)
|
A list of ciphers to use for SSL. For example,
RC4-SHA and TLSv1 are valid
cipher lists.
|
CURLOPT_SSL_EC_CURVES
(int)
|
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.
Available as of PHP 8.2.0 and cURL 7.73.0
|
CURLOPT_SSL_ENABLE_ALPN
(int)
|
false to disable ALPN in the SSL handshake (if the SSL backend
libcurl is built to use supports it), which can be used to
negotiate http2.
Available as of PHP 7.0.7 and cURL 7.36.0
|
CURLOPT_SSL_ENABLE_NPN
(int)
|
false to disable NPN in the SSL handshake (if the SSL backend
libcurl is built to use supports it), which can be used to
negotiate http2.
Available as of PHP 7.0.7 and cURL 7.36.0
|
CURLOPT_SSL_FALSESTART
(int)
|
true to enable TLS false start.
Available as of PHP 7.0.7 and cURL 7.42.0
|
CURLOPT_SSL_OPTIONS
(int)
|
Set SSL behavior options, which is a bitmask of the following constants:
CURLSSLOPT_ALLOW_BEAST , CURLSSLOPT_NO_REVOKE , CURLSSLOPT_AUTO_CLIENT_CERT , CURLSSLOPT_NATIVE_CA , CURLSSLOPT_NO_PARTIALCHAIN , CURLSSLOPT_REVOKE_BEST_EFFORT
Available as of PHP 7.0.7. and cURL 7.25.0
|
CURLOPT_SSL_VERIFYHOST
(int)
|
2 to verify that a Common Name field or a Subject Alternate Name
field in the SSL peer certificate matches the provided hostname.
0 to not check the names.
1 should not be used.
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.
|
CURLOPT_SSL_VERIFYPEER
(int)
|
false to stop cURL from verifying the peer's
certificate. Alternate certificates to verify against can be
specified with the CURLOPT_CAINFO option
or a certificate directory can be specified with the
CURLOPT_CAPATH option. true by default as of cURL 7.10. Default bundle installed as of
cURL 7.10.
|
CURLOPT_SSL_VERIFYSTATUS
(int)
|
true to verify the certificate's status.
Available as of PHP 7.0.7 and cURL 7.41.0
|
CURLOPT_STDERR
(int)
|
An alternative location to output errors to instead of
STDERR .
|
CURLOPT_STREAM_WEIGHT
(int)
|
Set the numerical stream weight (a number between 1 and 256).
Available as of PHP 7.0.7 and cURL 7.46.0
|
true to suppress proxy CONNECT response headers from the user callback functions
CURLOPT_HEADERFUNCTION and CURLOPT_WRITEFUNCTION ,
when CURLOPT_HTTPPROXYTUNNEL is used and a CONNECT request is made.
Available as of PHP 7.3.0 and cURL 7.54.0
|
CURLOPT_TCP_FASTOPEN
(int)
|
true to enable TCP Fast Open.
Available as of PHP 7.0.7 and cURL 7.49.0
|
CURLOPT_TCP_KEEPALIVE
(int)
|
If set to 1 , TCP keepalive probes will be sent. The delay and
frequency of these probes can be controlled by the CURLOPT_TCP_KEEPIDLE
and CURLOPT_TCP_KEEPINTVL options, provided the operating system
supports them. If set to 0 (default) keepalive probes are disabled.
Available as of cURL 7.25.0
|
CURLOPT_TCP_KEEPIDLE
(int)
|
Sets the delay, in seconds, that the operating system will wait while the connection is
idle before sending keepalive probes, if CURLOPT_TCP_KEEPALIVE is
enabled. Not all operating systems support this option.
The default is 60 .
Available as of cURL 7.25.0
|
CURLOPT_TCP_KEEPINTVL
(int)
|
Sets the interval, in seconds, that the operating system will wait between sending
keepalive probes, if CURLOPT_TCP_KEEPALIVE is enabled.
Not all operating systems support this option.
The default is 60 .
Available as of cURL 7.25.0
|
CURLOPT_TCP_NODELAY
(int)
|
true to disable TCP's Nagle algorithm, which tries to minimize
the number of small packets on the network.
Available as of cURL 7.11.2.
|
CURLOPT_TFTP_NO_OPTIONS
(int)
|
true to not send TFTP options requests.
Available as of PHP 7.0.7 and cURL 7.48.0
|
CURLOPT_TIMECONDITION
(int)
|
How CURLOPT_TIMEVALUE is treated.
Use CURL_TIMECOND_IFMODSINCE to 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 CURLOPT_HEADER is true .
Use CURL_TIMECOND_IFUNMODSINCE for the reverse
effect. Use CURL_TIMECOND_NONE to ignore
CURLOPT_TIMEVALUE and always return the page.
CURL_TIMECOND_NONE is the default. Before cURL 7.46.0 the default was
CURL_TIMECOND_IFMODSINCE .
|
CURLOPT_TIMEOUT
(int)
|
The maximum number of seconds to allow cURL functions to execute.
|
CURLOPT_TIMEOUT_MS
(int)
|
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.
Available as of cURL 7.16.2.
|
CURLOPT_TIMEVALUE
(int)
|
The time in seconds since January 1st, 1970. The time will be used
by CURLOPT_TIMECONDITION .
|
CURLOPT_TIMEVALUE_LARGE
(int)
|
The time in seconds since January 1st, 1970. The time will be used
by CURLOPT_TIMECONDITION . Defaults to zero.
The difference between this option and CURLOPT_TIMEVALUE
is the type of the argument. On systems where 'long' is only 32 bit wide,
this option has to be used to set dates beyond the year 2038.
Available as of PHP 7.3.0 and cURL 7.59.0
|
CURLOPT_TLS13_CIPHERS
(int)
|
The list of cipher suites to use for the TLS 1.3 connection. 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_SSL_CIPHER_LIST option. Available when built with OpenSSL >= 1.1.1.
Available as of PHP 7.3.0 and cURL 7.61.0
|
CURLOPT_TRANSFERTEXT
(int)
|
true to 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.
|
CURLOPT_UNIX_SOCKET_PATH
(int)
|
Enables the use of Unix domain sockets as connection endpoint and
sets the path to the given string.
Available as of PHP 7.0.7 and cURL 7.40.0
|
CURLOPT_UNRESTRICTED_AUTH
(int)
|
true to keep sending the username and password
when following locations (using
CURLOPT_FOLLOWLOCATION ), even when the
hostname has changed.
|
CURLOPT_UPKEEP_INTERVAL_MS
(int)
|
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.
Available as of PHP 8.2.0 and cURL 7.62.0
|
CURLOPT_UPLOAD
(int)
|
true to prepare for an upload.
|
CURLOPT_UPLOAD_BUFFERSIZE
(int)
|
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.
Available as of PHP 8.2.0 and cURL 7.62.0
|
CURLOPT_URL
(int)
|
The URL to fetch. This can also be set when initializing a
session with curl_init().
|
CURLOPT_USERAGENT
(int)
|
The contents of the "User-Agent: " header to be
used in a HTTP request.
|
CURLOPT_USERNAME
(int)
|
The user name to use in authentication.
Available as of cURL 7.19.1
|
CURLOPT_USERPWD
(int)
|
A username and password formatted as
"[username]:[password]" to use for the
connection.
|
CURLOPT_VERBOSE
(int)
|
true to output verbose information. Writes
output to STDERR , or the file specified using
CURLOPT_STDERR .
|
CURLOPT_WRITEFUNCTION
(int)
|
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.
|
The file that the header part of the transfer is written to.
|
CURLOPT_WS_OPTIONS
(int)
|
Available as of PHP 8.3.0 and cURL 7.86.0
|
CURLOPT_XFERINFOFUNCTION
(int)
|
A callback accepting two parameters.
Has a similar purpose as CURLOPT_PROGRESSFUNCTION but is more modern
and the preferred option from cURL.
Available as of PHP 8.2.0 and cURL 7.32.0.
|
CURLOPT_XOAUTH2_BEARER
(int)
|
Specifies the OAuth 2.0 access token.
Available as of PHP 7.0.7 and cURL 7.33.0
|
Constants |
Description |
curl_getinfo()
CURLINFO_APPCONNECT_TIME
(int)
|
Time in seconds it took from the start until the SSL/SSH connect/handshake to the remote host was completed
|
CURLINFO_APPCONNECT_TIME_T
(int)
|
Time, in microseconds, it took from the start until the SSL/SSH connect/handshake to the remote host was completed.
Available as of PHP 7.3.0 and cURL 7.61.0
|
CURLINFO_CAINFO
(int)
|
Default built-in CA certificate path.
Available as of PHP 8.3.0 and cURL 7.84.0
|
CURLINFO_CAPATH
(int)
|
Default built-in CA path string.
Available as of PHP 8.3.0 and cURL 7.84.0
|
CURLINFO_CERTINFO
(int)
|
TLS certificate chain
|
CURLINFO_CONDITION_UNMET
(int)
|
Info on unmet time conditional
|
CURLINFO_CONNECT_TIME
(int)
|
Time in seconds it took to establish the connection
|
CURLINFO_CONNECT_TIME_T
(int)
|
Total time taken, in microseconds, from the start until the connection to the remote host (or proxy) was completed.
Available as of PHP 7.3.0 and cURL 7.61.0
|
CURLINFO_CONTENT_LENGTH_DOWNLOAD
(int)
|
Content length of download, read from Content-Length: field
|
CURLINFO_CONTENT_LENGTH_DOWNLOAD_T
(int)
|
The content-length of the download. This is the value read from the Content-Length: field. -1 if the size isn't known.
Available as of PHP 7.3.0 and cURL 7.55.0
|
CURLINFO_CONTENT_LENGTH_UPLOAD
(int)
|
Specified size of upload
|
CURLINFO_CONTENT_LENGTH_UPLOAD_T
(int)
|
The specified size of the upload. -1 if the size isn't known.
Available as of PHP 7.3.0 and cURL 7.55.0
|
CURLINFO_CONTENT_TYPE
(int)
|
Content-Type of the requested document.
NULL indicates server did not send valid Content-Type header
|
CURLINFO_COOKIELIST
(int)
|
All known cookies
|
CURLINFO_EFFECTIVE_METHOD
(int)
|
Get the last used HTTP method.
|
CURLINFO_EFFECTIVE_URL
(int)
|
Last effective URL
|
CURLINFO_FILETIME
(int)
|
Remote time of the retrieved document, with the CURLOPT_FILETIME enabled; if -1 is returned the time of the document is unknown
|
CURLINFO_FILETIME_T
(int)
|
Remote time of the retrieved document (as Unix timestamp), an alternative to CURLINFO_FILETIME to allow systems with 32 bit long variables to extract dates outside of the 32bit timestamp range.
Available as of PHP 7.3.0 and cURL 7.59.0
|
CURLINFO_FTP_ENTRY_PATH
(int)
|
Entry path in FTP server
|
The request string sent. For this to work, add the CURLINFO_HEADER_OUT option to the handle by calling curl_setopt()
|
Total size of all headers received
|
CURLINFO_HTTPAUTH_AVAIL
(int)
|
Bitmask indicating the authentication method(s) available according to the previous response
|
CURLINFO_HTTP_CODE
(int)
|
The last response code.
As of cURL 7.10.8, this is a legacy alias of CURLINFO_RESPONSE_CODE .
|
CURLINFO_HTTP_CONNECTCODE
(int)
|
The CONNECT response code
|
CURLINFO_HTTP_VERSION
(int)
|
The version used in the last HTTP connection. The return value will be one of the defined CURL_HTTP_VERSION_* constants or 0 if the version can't be determined.
Available as of PHP 7.3.0 and cURL 7.50.0
|
CURLINFO_LASTONE
(int)
|
The last enum value in the underlying CURLINFO enum
in libcurl .
|
CURLINFO_LOCAL_IP
(int)
|
Local (source) IP address of the most recent connection
|
CURLINFO_LOCAL_PORT
(int)
|
Local (source) port of the most recent connection
|
CURLINFO_NAMELOOKUP_TIME
(int)
|
Time in seconds until name resolving was complete
|
CURLINFO_NAMELOOKUP_TIME_T
(int)
|
Time in microseconds from the start until the name resolving was completed.
Available as of PHP 7.3.0 and cURL 7.61.0
|
CURLINFO_NUM_CONNECTS
(int)
|
Number of connections curl had to create to achieve the previous transfer
|
CURLINFO_OS_ERRNO
(int)
|
Errno from a connect failure. The number is OS and system specific.
|
CURLINFO_PRETRANSFER_TIME
(int)
|
Time in seconds from start until just before file transfer begins
|
CURLINFO_PRETRANSFER_TIME_T
(int)
|
Time taken from the start until the file transfer is just about to begin, in microseconds.
Available as of PHP 7.3.0 and cURL 7.61.0
|
CURLINFO_PRIMARY_IP
(int)
|
IP address of the most recent connection
|
CURLINFO_PRIMARY_PORT
(int)
|
Destination port of the most recent connection
|
CURLINFO_PRIVATE
(int)
|
Private data associated with this cURL handle, previously set with the CURLOPT_PRIVATE option of curl_setopt()
|
CURLINFO_PROTOCOL
(int)
|
The protocol used in the last HTTP connection. The returned value will be exactly one of the CURLPROTO_* values.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLINFO_PROXYAUTH_AVAIL
(int)
|
Bitmask indicating the proxy authentication method(s) available according to the previous response
|
CURLINFO_PROXY_ERROR
(int)
|
The detailed (SOCKS) proxy error code when the most recent transfer returned a CURLE_PROXY error. The returned value will be exactly one of the CURLPX_* values. The error code will be CURLPX_OK if no response code was available.
Available as of PHP 8.2.0 and cURL 7.73.0
|
CURLINFO_PROXY_SSL_VERIFYRESULT
(int)
|
The result of the certificate verification that was requested (using the CURLOPT_PROXY_SSL_VERIFYPEER option). Only used for HTTPS proxies.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLINFO_REDIRECT_COUNT
(int)
|
Number of redirects, with the CURLOPT_FOLLOWLOCATION option enabled
|
CURLINFO_REDIRECT_TIME
(int)
|
Time in seconds of all redirection steps before final transaction was started, with the CURLOPT_FOLLOWLOCATION option enabled
|
CURLINFO_REDIRECT_TIME_T
(int)
|
Total time, in microseconds, it took for all redirection steps include name lookup, connect, pretransfer and transfer before final transaction was started.
Available as of PHP 7.3.0 and cURL 7.61.0
|
CURLINFO_REDIRECT_URL
(int)
|
With the CURLOPT_FOLLOWLOCATION option disabled: redirect URL found in the last transaction, that should be requested manually next. With the CURLOPT_FOLLOWLOCATION option enabled: this is empty. The redirect URL in this case is available in CURLINFO_EFFECTIVE_URL
|
CURLINFO_REFERER
(int)
|
The Referer header.
Available as of PHP 8.2.0 and cURL 7.76.0
|
CURLINFO_REQUEST_SIZE
(int)
|
Total size of issued requests, currently only for HTTP requests
|
CURLINFO_RESPONSE_CODE
(int)
|
The last response code.
Available as of cURL 7.10.8
|
CURLINFO_RETRY_AFTER
(int)
|
The information from the Retry-After header, or zero if there was no valid header.
Available as of PHP 8.2.0 and cURL 7.66.0
|
CURLINFO_RTSP_CLIENT_CSEQ
(int)
|
Next RTSP client CSeq
|
CURLINFO_RTSP_CSEQ_RECV
(int)
|
Recently received CSeq
|
CURLINFO_RTSP_SERVER_CSEQ
(int)
|
Next RTSP server CSeq
|
CURLINFO_RTSP_SESSION_ID
(int)
|
RTSP session ID
|
CURLINFO_SCHEME
(int)
|
The URL scheme used for the most recent connection.
Available as of PHP 7.3.0 and cURL 7.52.0
|
CURLINFO_SIZE_DOWNLOAD
(int)
|
Total number of bytes downloaded
|
CURLINFO_SIZE_DOWNLOAD_T
(int)
|
Total number of bytes that were downloaded. The number is only for the latest transfer and will be reset again for each new transfer.
Available as of PHP 7.3.0 and cURL 7.50.0
|
CURLINFO_SIZE_UPLOAD
(int)
|
Total number of bytes uploaded
|
CURLINFO_SIZE_UPLOAD_T
(int)
|
Total number of bytes that were uploaded.
Available as of PHP 7.3.0 and cURL 7.50.0
|
CURLINFO_SPEED_DOWNLOAD
(int)
|
Average download speed
|
CURLINFO_SPEED_DOWNLOAD_T
(int)
|
The average download speed in bytes/second that curl measured for the complete download.
Available as of PHP 7.3.0 and cURL 7.50.0
|
CURLINFO_SPEED_UPLOAD
(int)
|
Average upload speed
|
CURLINFO_SPEED_UPLOAD_T
(int)
|
The average upload speed in bytes/second that curl measured for the complete upload.
Available as of PHP 7.3.0 and cURL 7.50.0
|
CURLINFO_SSL_ENGINES
(int)
|
OpenSSL crypto-engines supported
|
CURLINFO_SSL_VERIFYRESULT
(int)
|
Result of SSL certification verification requested by setting CURLOPT_SSL_VERIFYPEER
|
CURLINFO_STARTTRANSFER_TIME
(int)
|
Time in seconds until the first byte is about to be transferred
|
CURLINFO_STARTTRANSFER_TIME_T
(int)
|
Time, in microseconds, it took from the start until the first byte is received.
Available as of PHP 7.3.0 and cURL 7.61.0
|
CURLINFO_TOTAL_TIME
(int)
|
Total transaction time in seconds for last transfer
|
CURLINFO_TOTAL_TIME_T
(int)
|
Total time in microseconds for the previous transfer, including name resolving, TCP connect etc.
Available as of PHP 7.3.0 and cURL 7.61.0
|