From 60609ea6c8af618bc168dccbf9a50f8ddbfb0549 Mon Sep 17 00:00:00 2001 From: nsfisis Date: Fri, 2 May 2025 20:37:47 +0900 Subject: [PATCH 1/6] =?UTF-8?q?=E6=9C=AA=E8=A8=B3=E3=83=95=E3=82=A1?= =?UTF-8?q?=E3=82=A4=E3=83=AB=20reference/curl/constants=5Fcurl=5Fsetopt.x?= =?UTF-8?q?ml=20=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- reference/curl/constants_curl_setopt.xml | 4682 ++++++++++++++++++++++ 1 file changed, 4682 insertions(+) create mode 100644 reference/curl/constants_curl_setopt.xml diff --git a/reference/curl/constants_curl_setopt.xml b/reference/curl/constants_curl_setopt.xml new file mode 100644 index 0000000000..8f3c4fe12d --- /dev/null +++ b/reference/curl/constants_curl_setopt.xml @@ -0,0 +1,4682 @@ + + + + + <function>curl_setopt</function> + + + 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_ACCEPT_ENCODING + (int) + + + + Sets a string with the contents + of the Accept-Encoding: header sent in an HTTP request. + Set to &null; to disable sending the Accept-Encoding: header. + Defaults to &null;. + Available as of cURL 7.21.6. + + + + + + CURLOPT_ACCEPTTIMEOUT_MS + (int) + + + + The maximum number of milliseconds to wait for a server + to connect back to cURL when an active FTP connection is used. + This option accepts any value that can be cast to a valid int. + Defaults to 60000 milliseconds. + Available as of cURL 7.24.0. + + + + + + CURLOPT_ADDRESS_SCOPE + (int) + + + + The scope id value to use when connecting to IPv6 addresses. + This option accepts any value that can be cast to a valid int. + Defaults to 0. + Available as of cURL 7.19.0. + + + + + + CURLOPT_ALTSVC + (int) + + + + Pass a string with 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. + Set to any of the + CURLALTSVC_* constants. + Defaults to Alt-Svc handling being disabled. + Available as of PHP 8.2.0 and cURL 7.64.1. + + + + + + CURLOPT_APPEND + (int) + + + + Setting this option to 1 will cause FTP uploads + to append to the remote file instead of overwriting it. + Defaults to 0. + Available as of cURL 7.17.0. + + + + + + CURLOPT_AUTOREFERER + (int) + + + + &true; to automatically set the Referer: field in + requests where it follows a Location: redirect. + Defaults to 0. + Available as of cURL 7.1.0. + + + + + + CURLOPT_AWS_SIGV4 + (int) + + + + Provides AWS V4 signature authentication on HTTP(S) header as a string. + 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) + + + + This constant is no longer used as of PHP 5.5.0. + Deprecated as of PHP 8.4.0. + + + + + + CURLOPT_BUFFERSIZE + (int) + + + + The size of the buffer to use for each read. There is no guarantee + this request will be fulfilled, however. + This option accepts any value that can be cast to a valid int. + Defaults to CURL_MAX_WRITE_SIZE (currently, 16kB). + Available as of cURL 7.10. + + + + + + CURLOPT_CAINFO + (int) + + + + A string with 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. + Available as of cURL 7.4.2. + + + + + + CURLOPT_CAINFO_BLOB + (int) + + + + A string with 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 string with a directory that holds multiple CA certificates. + Use this option alongside CURLOPT_SSL_VERIFYPEER. + Available as of cURL 7.9.8. + + + + + + CURLOPT_CA_CACHE_TIMEOUT + (int) + + + + Sets the maximum time in seconds any in memory cached CA certificate store + may be kept and reused for new connections. + This option accepts any value that can be cast to a valid int. + Defaults to 86400 (24 hours). + 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. + Requires CURLOPT_VERBOSE to be on to have an effect. + Defaults to &false;. + Available as of cURL 7.19.1. + + + + + + CURLOPT_CONNECTTIMEOUT + (int) + + + + The number of seconds to wait while trying to connect. Use 0 to + wait indefinitely. + This option accepts any value that can be cast to a valid int. + Defaults to 300. + Available as of cURL 7.7.0. + + + + + + CURLOPT_CONNECTTIMEOUT_MS + (int) + + + + The number of milliseconds to wait while trying to connect. + Use 0 to wait indefinitely. + If cURL 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. + This option accepts any value that can be cast to a valid int. + Defaults to 300000. + 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. + Defaults to &false;. + 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) + + + + A string with 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). + Available as of cURL 7.1.0. + + + + + + CURLOPT_COOKIEFILE + (int) + + + + A string with 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. + Available as of cURL 7.1.0. + + + + + + CURLOPT_COOKIEJAR + (int) + + + + A string with the name of a file to save all internal cookies to when + the handle's destructor is called. + Available as of cURL 7.9.0. + + + 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, run curl_setopt($ch, CURLOPT_COOKIELIST, "FLUSH");. + + + + + + + + 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 cURL + to ignore all cookies it is about to load that are "session cookies" + from the previous session. By default, cURL 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. + Available as of cURL 7.9.7. + + + + + + CURLOPT_CRLF + (int) + + + + &true; to convert Unix newlines to CRLF newlines + on transfers. + Available as of cURL 7.1.0. + + + + + + CURLOPT_CRLFILE + (int) + + + + Pass a string naming a file with the concatenation of + CRL (Certificate Revocation List) (in PEM format) + to use in the certificate validation that occurs during the SSL exchange. + When cURL is built to use GnuTLS, + there is no way to influence the use of CRL passed + to help in the verification process. + When cURL is built with OpenSSL support, + X509_V_FLAG_CRL_CHECK + and X509_V_FLAG_CRL_CHECK_ALL are both set, + requiring CRL check against all the elements of the certificate chain + if a CRL file is passed. + Also note that CURLOPT_CRLFILE implies + CURLSSLOPT_NO_PARTIALCHAIN + as of cURL 7.71.0 due to an OpenSSL bug. + Available as of cURL 7.19.0. + + + + + + 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. + This option accepts a string or &null;. + Available as of cURL 7.1.0. + + + Don't do this without making sure the server supports the custom + request method first. + + + + + + + + CURLOPT_DEFAULT_PROTOCOL + (int) + + + + A string with 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_DIRLISTONLY + (int) + + + + Setting this option to 1 will have different effects + based on the protocol it is used with. + FTP and SFTP based URLs will list only the names of files in a directory. + POP3 will list the email message or messages on the POP3 server. + For FILE, this option has no effect + as directories are always listed in this mode. + Using this option with CURLOPT_WILDCARDMATCH + will prevent the latter from having any effect. + Defaults to 0. + Available as of cURL 7.17.0. + + + + + + CURLOPT_DISALLOW_USERNAME_IN_URL + (int) + + + + &true; to not allow URLs that include a username. + Usernames are allowed by default. + 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. + This option accepts any value that can be cast to a valid int. + Available as of cURL 7.9.3. + + + + + + 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). + This option accepts a string or &null;. + 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. + This option accepts a string or &null;. + 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. + This option accepts a string or &null;. + Available as of PHP 7.0.7 and cURL 7.33.0. + + + + + + CURLOPT_DNS_SERVERS + (int) + + + + Pass a string with a comma-separated list of DNS servers to be used + instead of the system default + (e.g.: 192.168.1.100,192.168.1.101:8080). + Available as of cURL 7.24.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.). + Available as of cURL 7.9.3 and deprecated as of cURL 7.11.1. + As of PHP 8.4, this option no longer has any effect. + + + + + + CURLOPT_DOH_SSL_VERIFYHOST + (int) + + + + Set to 2 to 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) + + + + Set to 1 to enable and 0 to disable + verification of 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) + + + + Set to 1 to enable and 0 to disable + the verification of 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. + This option accepts a string or &null;. + 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. + Available as of cURL 7.7.0 and deprecated as of cURL 7.84.0. + + + + + + CURLOPT_ENCODING + (int) + + + + The contents of the Accept-Encoding: header as a string. + This enables decoding of the response. Supported encodings are: + + identity + deflate + gzip + . + If an empty string is set, + a header containing all supported encoding types is sent. + Available as of cURL 7.10 and deprecated as of cURL 7.21.6. + + + + + + CURLOPT_EXPECT_100_TIMEOUT_MS + (int) + + + + The timeout for Expect: 100-continue responses in milliseconds. + Defaults to 1000 milliseconds. + This option accepts any value that can be cast to a valid int. + 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. + Available as of cURL 7.1.0. + + + + + + CURLOPT_FILE + (int) + + + + Accepts a file handle resource + to the file that the transfer should be written to. + The default is STDOUT (the browser window). + Available as of cURL 7.1.0 and deprecated as of cURL 7.9.7. + + + + + + CURLOPT_FILETIME + (int) + + + + Set to &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. + Available as of cURL 7.5.0. + + + + + + CURLOPT_FNMATCH_FUNCTION + (int) + + + + Pass a callable that will be used for wildcard matching. + The signature of the callback should be: + + intcallback + resourcecurlHandle + stringpattern + stringstring + + + + curlHandle + + + The cURL handle. + + + + + pattern + + + The wildcard pattern. + + + + + string + + + The string to run the wildcard pattern matching on. + + + + + The callback should return + CURL_FNMATCHFUNC_MATCH if pattern matches the string, + CURL_FNMATCHFUNC_NOMATCH if not + or CURL_FNMATCHFUNC_FAIL if an error occurred. + Available as of cURL 7.21.0. + + + + + + CURLOPT_FOLLOWLOCATION + (int) + + + + Set to &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. + Available as of cURL 7.1.0. + + + + + + CURLOPT_FORBID_REUSE + (int) + + + + Set to &true; to force the connection to explicitly + close when it has finished processing, and not be pooled for reuse. + Available as of cURL 7.7.0. + + + + + + CURLOPT_FRESH_CONNECT + (int) + + + + Set to &true; to force the use of a new connection + instead of a cached one. + Available as of cURL 7.7.0. + + + + + + CURLOPT_FTPAPPEND + (int) + + + + Set to &true; to append to the remote file instead of + overwriting it. + Available as of cURL 7.1.0 and deprecated as of cURL 7.16.4. + + + + + + CURLOPT_FTPASCII + (int) + + + + An alias of + CURLOPT_TRANSFERTEXT. Use that instead. + Available as of cURL 7.1, deprecated as of cURL 7.11.1 + and last available in cURL 7.15.5. + Removed as of PHP 7.3.0. + + + + + + CURLOPT_FTPLISTONLY + (int) + + + + Set to &true; to only list the names of an FTP directory. + Available as of cURL 7.1.0 and deprecated as of cURL 7.16.4. + + + + + + CURLOPT_FTPPORT + (int) + + + + A string 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 system's default IP address. + This option accepts a string or &null;. + Available as of cURL 7.1.0. + + + + + + CURLOPT_FTPSSLAUTH + (int) + + + + Set the FTP over SSL authentication method (if activated) to any of the + CURLFTPAUTH_* constants. + Defaults to CURLFTPAUTH_DEFAULT. + Available as of cURL 7.12.2. + + + + + + CURLOPT_FTP_ACCOUNT + (int) + + + + Pass a string that will be sent as account information over FTP + (using the ACCT command) after username and password has been provided + to the server. + Set to &null; to disable sending the account information. + Defaults to &null;. + Available as of cURL 7.13.0. + + + + + + CURLOPT_FTP_ALTERNATIVE_TO_USER + (int) + + + + Pass a string that will be used to try to authenticate over FTP + if the USER/PASS negotiation fails. + Available as of cURL 7.15.5. + + + + + + CURLOPT_FTP_CREATE_MISSING_DIRS + (int) + + + + Set to &true; to create missing directories when an FTP operation + encounters a path that currently doesn't exist. + Available as of cURL 7.10.7. + + + + + + CURLOPT_FTP_FILEMETHOD + (int) + + + + Tell cURL which method to use to reach a file on a FTP(S) server. Possible values are + any of the CURLFTPMETHOD_* constants. + Defaults to CURLFTPMETHOD_MULTICWD. + Available as of cURL 7.15.1. + + + + + + CURLOPT_FTP_RESPONSE_TIMEOUT + (int) + + + + A timeout in seconds cURL will wait for a response from an FTP server. + This option overrides CURLOPT_TIMEOUT. + This option accepts any value that can be cast to a valid int. + This option name is replaced with CURLOPT_SERVER_RESPONSE_TIMEOUT, + available as of PHP 8.4.0. + Available as of cURL 7.10.8 and deprecated as of cURL 7.85.0. + + + + + + CURLOPT_FTP_SKIP_PASV_IP + (int) + + + + If this option is set to 1 + cURL will not use the IP address the server suggests + in its 227-response to cURL's PASV command + but will use the IP address it used for the connection. + The port number received from the 227-response will not be ignored by cURL. + Defaults to 1 as of cURL 7.74.0 + and 0 prior to that. + Available as of cURL 7.15.0. + + + + + + CURLOPT_FTP_SSL + (int) + + + + Available as of cURL 7.11.0 and deprecated as of cURL 7.16.4. + + + + + + CURLOPT_FTP_SSL_CCC + (int) + + + + This option makes cURL use CCC (Clear Command Channel) + which shuts down the SSL/TLS layer after authenticating + making the rest of the control channel communication unencrypted. + Use one of the CURLFTPSSL_CCC_* constants. + Defaults to CURLFTPSSL_CCC_NONE. + Available as of cURL 7.16.1. + + + + + + CURLOPT_FTP_USE_EPRT + (int) + + + + Set to &true; to use EPRT (and LPRT) when doing active FTP downloads. + Set to &false; to disable EPRT and LPRT and use PORT only. + Available as of cURL 7.10.5. + + + + + + CURLOPT_FTP_USE_EPSV + (int) + + + + Set to &true; to first try an EPSV command for FTP transfers before reverting back to PASV. + Set to &false; to disable EPSV. + Available as of cURL 7.9.2. + + + + + + CURLOPT_FTP_USE_PRET + (int) + + + + Set to 1 to send a PRET command + before PASV (and EPSV). + Has no effect when using the active FTP transfers mode. + Defaults to 0. + Available as of cURL 7.20.0. + + + + + + CURLOPT_GSSAPI_DELEGATION + (int) + + + + Set to CURLGSSAPI_DELEGATION_FLAG + to allow unconditional GSSAPI credential delegation. + Set to CURLGSSAPI_DELEGATION_POLICY_FLAG + to delegate only if the OK-AS-DELEGATE flag is set + in the service ticket. + Defaults to CURLGSSAPI_DELEGATION_NONE. + Available as of cURL 7.22.0. + + + + + + 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. + This option accepts any value that can be cast to a valid int. + 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. + + + + + + CURLOPT_HEADER + (int) + + + + Set to &true; to include the headers in the output sent to the callback + defined by CURLOPT_WRITEFUNCTION. + Available as of cURL 7.1.0. + + + + + + CURLOPT_HEADERFUNCTION + (int) + + + + A callable with the following signature: + + intcallback + resourcecurlHandle + stringheaderData + + + + curlHandle + + + The cURL handle. + + + + + headerData + + + The header data which must be written by the callback. + + + + + The callback should return the number of bytes written. + Available as of cURL 7.7.2. + + + + + + CURLOPT_HEADEROPT + (int) + + + + Send HTTP headers to both proxy and host or separately. + Possible values are any of the + CURLHEADER_* constants. + Defaults to CURLHEADER_SEPARATE as of cURL + 7.42.1, and CURLHEADER_UNIFIED prior to that. + Available as of PHP 7.0.7 and cURL 7.37.0. + + + + + + CURLOPT_HSTS + (int) + + + + string with HSTS (HTTP Strict Transport Security) cache file name + or &null; to allow HSTS without reading from or writing to any file + and clear the list of files to read HSTS data from. + Available as of PHP 8.2.0 and cURL 7.74.0. + + + + + + CURLOPT_HSTS_CTRL + (int) + + + + Accepts a bitmask of HSTS (HTTP Strict Transport Security) features + defined by the CURLHSTS_* constants. + 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 cURL 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) + + + + A bitmask of HTTP authentication method(s) to use. The options are: + + CURLAUTH_BASIC + CURLAUTH_DIGEST + CURLAUTH_GSSNEGOTIATE + CURLAUTH_NTLM + CURLAUTH_AWS_SIGV4 + CURLAUTH_ANY + CURLAUTH_ANYSAFE + . + If more than one method is used, 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. + Available as of cURL 7.10.6. + + + + + + CURLOPT_HTTPGET + (int) + + + + Set to &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. + Available as of cURL 7.8.1. + + + + + + CURLOPT_HTTPHEADER + (int) + + + + An array of HTTP header fields to set, in the format + + array('Content-type: text/plain', 'Content-length: 100') + + Available as of cURL 7.1.0. + + + + + + CURLOPT_HTTPPROXYTUNNEL + (int) + + + + &true; to tunnel through a given HTTP proxy. + Available as of cURL 7.3.0. + + + + + + CURLOPT_HTTP_CONTENT_DECODING + (int) + + + + &false; to get the raw HTTP response body. + Available as of cURL 7.16.2. + + + + + + CURLOPT_HTTP_TRANSFER_DECODING + (int) + + + + If set to 0, transfer decoding is disabled. + If set to 1, transfer decoding is enabled. + cURL does chunked transfer decoding by default + unless this option is set to 0. + Defaults to 1. + Available as of cURL 7.16.2. + + + + + + CURLOPT_HTTP_VERSION + (int) + + + + Set to one of the + CURL_HTTP_VERSION_* constants + for cURL to use the specified HTTP version. + Available as of cURL 7.9.1. + + + + + + CURLOPT_IGNORE_CONTENT_LENGTH + (int) + + + + If set to 1, + ignore the Content-Length header in the HTTP response + and ignore asking for or relying on it for FTP transfers. + Defaults to 0. + Available as of cURL 7.14.1. + + + + + + CURLOPT_INFILE + (int) + + + + Accepts a file handle resource + to the file that the transfer should be read from when uploading. + Available as of cURL 7.1.0 and deprecated as of cURL 7.9.7. + Use CURLOPT_READDATA instead. + + + + + + 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 cURL + from sending more data, as exactly what is sent depends on + CURLOPT_READFUNCTION. + This option accepts any value that can be cast to a valid int. + Available as of cURL 7.1.0. + + + + + + CURLOPT_INTERFACE + (int) + + + + Set to a string with the name of the outgoing network interface to use. + This can be an interface name, an IP address or a host name. + Available as of cURL 7.1.0. + + + + + + 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. + Set to one of the + CURL_IPRESOLVE_* constants. + Defaults to CURL_IPRESOLVE_WHATEVER. + Available as of cURL 7.10.8. + + + + + + CURLOPT_ISSUERCERT + (int) + + + + If set to a string naming a file holding a CA certificate in PEM format, + an additional check against the peer certificate is performed + to verify the issuer is indeed the one associated + with the certificate provided by the option. + For the result of the check to be considered a failure, + this option should be used in combination with the + CURLOPT_SSL_VERIFYPEER option. + Available as of cURL 7.19.0. + + + + + + CURLOPT_ISSUERCERT_BLOB + (int) + + + + Pass a string with binary data of a CA SSL certificate in PEM format. + If set, an additional check against the peer certificate is performed + to verify the issuer is the one associated with the certificate provided by the option. + Available as of PHP 8.1.0 and cURL 7.71.0. + + + + + + CURLOPT_KEEP_SENDING_ON_ERROR + (int) + + + + Set to &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) + + + + Set to a string with the password required to use the CURLOPT_SSLKEY + or CURLOPT_SSH_PRIVATE_KEYFILE private key. + Setting this option to &null; disables using a password for these options. + Available as of cURL 7.17.0. + + + + + + CURLOPT_KRB4LEVEL + (int) + + + + The KRB4 (Kerberos 4) security level. Any of the following string 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. + Available as of cURL 7.3.0 and deprecated as of cURL 7.17.0. + + + + + + CURLOPT_KRBLEVEL + (int) + + + + Set the kerberos security level for FTP and also enables kerberos awareness. + This should be set to one of the following strings: + + clear + safe + confidential + private + . + If the string is set but does not match one of these, + private is used. + Setting this option to &null; will disable kerberos support for FTP. + Defaults to &null;. + Available as of cURL 7.16.4. + + + + + + CURLOPT_LOCALPORT + (int) + + + + Sets the local port number of the socket used for the connection. + This option accepts any value that can be cast to a valid int. + Defaults to 0. + Available as of cURL 7.15.2. + + + + + + CURLOPT_LOCALPORTRANGE + (int) + + + + The number of attempts cURL makes to find a working local port number, + starting with the one set with CURLOPT_LOCALPORT. + This option accepts any value that can be cast to a valid int. + Defaults to 1. + Available as of cURL 7.15.2. + + + + + + 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. + This option accepts any value that can be cast to a valid int. + Available as of cURL 7.1.0. + + + + + + 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. + This option accepts any value that can be cast to a valid int. + Available as of cURL 7.1.0. + + + + + + CURLOPT_MAIL_AUTH + (int) + + + + Set a string with the authentication address (identity) + of a submitted message that is being relayed to another server. + The address should not be specified within a pair of angled brackets + (><). + If an empty string is used then a pair of brackets are sent by cURL + as required by RFC 2554. + Available as of cURL 7.25.0. + + + + + + CURLOPT_MAIL_FROM + (int) + + + + Set a string with the sender's email address when sending SMTP mail. + The email address should be specified with angled brackets + (><) around it, + which if not specified are added automatically. + If this parameter is not specified then an empty address is sent + to the SMTP server which might cause the email to be rejected. + Available as of cURL 7.20.0. + + + + + + CURLOPT_MAIL_RCPT + (int) + + + + Set to an array of strings + with the recipients to pass to the server in an SMTP mail request. + Each recipient should be specified within a pair of angled brackets + (><). + If an angled bracket is not used as the first character, + cURL assumes a single email address has been provided + and encloses that address within brackets. + Available as of cURL 7.20.0. + + + + + + CURLOPT_MAIL_RCPT_ALLLOWFAILS + (int) + + + + Set to 1 to allow RCPT TO command + to fail for some recipients which makes cURL ignore errors + for individual recipients and proceed with the remaining accepted recipients. + If all recipients trigger failures and this flag is specified, + cURL aborts the SMTP conversation + and returns the error received from to the last RCPT TO command. + Replaced by CURLOPT_MAIL_RCPT_ALLOWFAILS as of cURL 8.2.0. + Available as of PHP 8.2.0 and cURL 7.69.0. + Deprecated as of cURL 8.2.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. + This option accepts any value that can be cast to a valid int. + 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. + This option accepts any value that can be cast to a valid int. + Available as of cURL 7.7.0. + + + + + + CURLOPT_MAXFILESIZE + (int) + + + + Sets the maximum accepted size (in bytes) of a file to download. + If the file requested is found larger than this value, + the transfer is aborted + and CURLE_FILESIZE_EXCEEDED is returned. + Passing 0 disables this option, + and passing a negative size returns a + CURLE_BAD_FUNCTION_ARGUMENT. + If the file size is not known prior to the start of download, + this option has no effect. + For setting a size limit above 2GB, + CURLOPT_MAXFILESIZE_LARGE should be used. + As of cURL 8.4.0, this option also stops ongoing transfers + if they reach this threshold. + This option accepts any value that can be cast to a valid int. + Defaults to 0. + Available as of cURL 7.10.8. + + + + + + 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. + This option accepts any value that can be cast to a valid int. + 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. + This option accepts any value that can be cast to a valid int. + 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. + Available as of cURL 7.5.0. + + + + + + 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. + This option accepts any value that can be cast to a valid int. + 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. + This option accepts any value that can be cast to a valid int. + Available as of cURL 7.15.5. + + + + + + CURLOPT_MIME_OPTIONS + (int) + + + + Set to a bitmask of CURLMIMEOPT_* + constants. Currently there is only one available option: + CURLMIMEOPT_FORMESCAPE. + Available as of PHP 8.3.0 and cURL 7.81.0. + + + + + + CURLOPT_MUTE + (int) + + + + Set to &true; to be completely silent with regards to + the cURL functions. + Use CURLOPT_RETURNTRANSFER instead. + Available as of cURL 7.1.0, deprecated as of cURL 7.8.0 + and last available in cURL 7.15.5. + Removed as of PHP 7.3.0. + + + + + + CURLOPT_NETRC + (int) + + + + Set to &true; to scan the ~/.netrc + file to find a username and password for the remote site that + a connection is being established with. + Available as of cURL 7.1.0. + + + + + + CURLOPT_NETRC_FILE + (int) + + + + Set a string containing the full path name to a .netrc file. + If this option is omitted and CURLOPT_NETRC is set, + cURL checks for a .netrc file + in the current user's home directory. + Available as of cURL 7.11.0. + + + + + + CURLOPT_NEW_DIRECTORY_PERMS + (int) + + + + Sets the value of the permissions (int) that is set on newly created directories + on the remote server. The default value is 0755. + The only protocols that can use this are + sftp://, scp:// + and file://. + Available as of cURL 7.16.4. + + + + + + CURLOPT_NEW_FILE_PERMS + (int) + + + + Sets the value of the permissions (as an int) that are set on newly created files + on the remote server. The default value is 0644. + The only protocols that can use this are + sftp://, scp:// + and file://. + Available as of cURL 7.16.4. + + + + + + CURLOPT_NOBODY + (int) + + + + Set to &true; to exclude the body from the output. + For HTTP(S), cURL makes a HEAD request. For most other protocols, + cURL is not asking for the body data at all. + Changing this to &false; will result in body data being included in the output. + Available as of cURL 7.1.0. + + + + + + CURLOPT_NOPROGRESS + (int) + + + + Set to &true; to disable the progress meter for cURL transfers. + + + PHP automatically sets this option to &true;, this should only be + changed for debugging purposes. + + + Available as of cURL 7.1.0. + + + + + + CURLOPT_NOPROXY + (int) + + + + Set a string consisting of a comma separated list of hostnames + that do not require a proxy to get reached. + Each name in this list is matched as either a domain + which contains the hostname or the hostname itself. + The only wildcard available in the string + is a single * character which matches all hosts, + effectively disabling the proxy. + Setting this option to an empty string enables the proxy for all hostnames. + Since cURL 7.86.0, IP addresses set with this option + can be provided using CIDR notation. + Available as of cURL 7.19.4. + + + + + + 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 callable with the following signature: + + stringcallback + resourcecurlHandle + stringpasswordPrompt + intmaximumPasswordLength + + + + curlHandle + + + The cURL handle. + + + + + passwordPrompt + + + A password prompt. + + + + + maximumPasswordLength + + + The maximum length of the password. + + + + + The callback should return a string containing the password. + Available as of cURL 7.4.2, deprecated as of cURL 7.11.1 + and last available in cURL 7.15.5. + Removed as of PHP 7.3.0. + + + + + + CURLOPT_PASSWORD + (int) + + + + Set to a string with the password to use in authentication. + Available as of cURL 7.19.1. + + + + + + CURLOPT_PATH_AS_IS + (int) + + + + Set to &true; for cURL not alter URL paths before passing them on to the server. + Defaults to &false;, which squashes sequences of /../ + or /./ that may exist in the URL's path part + which is supposed to be removed according to RFC 3986 section 5.2.4. + Available as of PHP 7.0.7 and cURL 7.42.0. + + + + + + CURLOPT_PINNEDPUBLICKEY + (int) + + + + Set a string with the pinned public key. + The string can be the file name of the pinned public key + in a PEM or DER file format. 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) + + + + Set to &true; to wait for an existing connection to confirm + whether it can do multiplexing and use it if it can + before creating and using a new connection. + Available as of PHP 7.0.7 and cURL 7.43.0. + + + + + + CURLOPT_PORT + (int) + + + + An int with an alternative port number to connect to + instead of the one specified in the URL or the default port for the used protocol. + Available as of cURL 7.1.0. + + + + + + CURLOPT_POST + (int) + + + + Set to &true; to do a HTTP POST request. + This request uses the application/x-www-form-urlencoded header. + Defaults to &false;. + Available as of cURL 7.1.0. + + + + + + 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&para2=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. + Available as of cURL 7.1.0. + + + + + + CURLOPT_POSTQUOTE + (int) + + + + An array of FTP command strings + to execute on the server after the FTP request has been performed. + Available as of cURL 7.1.0. + + + + + + CURLOPT_POSTREDIR + (int) + + + + Set to a bitmask of CURL_REDIR_POST_301, + CURL_REDIR_POST_302 and CURL_REDIR_POST_303 + 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_PREQUOTE + (int) + + + + Set an array of FTP command strings to pass to the server + after the transfer type is set. + These commands are not performed when a directory listing is performed, + only for file transfers. + Available as of cURL 7.9.5. + + + + + + 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 callable with the following signature: + + intcallback + resourcecurlHandle + intbytesToDownload + intbytesDownloaded + intbytesToUpload + intbytesUploaded + + + + curlHandle + + + The cURL handle. + + + + + bytesToDownload + + + The total number of bytes expected to be downloaded in this transfer. + + + + + bytesDownloaded + + + The number of bytes downloaded so far. + + + + + bytesToUpload + + + The total number of bytes expected to be uploaded in this transfer. + + + + + bytesUploaded + + + The number of bytes uploaded so far. + + + + + The callback should return an int with a non-zero value to abort the transfer + and set a CURLE_ABORTED_BY_CALLBACK error. + + + The callback is only called when the CURLOPT_NOPROGRESS + option is set to &false;. + + + Available as of cURL 7.1.0 and deprecated as of cURL 7.32.0. + Use CURLOPT_XFERINFOFUNCTION instead. + + + + + + CURLOPT_PROTOCOLS + (int) + + + + Bitmask of CURLPROTO_* values. + If used, this bitmask limits what protocols cURL may use in the transfer. + Defaults to CURLPROTO_ALL, ie. cURL will accept all protocols it supports. + See also CURLOPT_REDIR_PROTOCOLS. + Available as of cURL 7.19.4 and deprecated as of cURL 7.85.0. + + + + + + CURLOPT_PROTOCOLS_STR + (int) + + + + Set to a string with a comma separated list + of case insensitive protocol names (URL schemes) to allow in the transfer. + Set to ALL to enable all protocols. + By default, cURL accepts all protocols it was built with support for. + Available protocols are: + + DICT + FILE + FTP + FTPS + GOPHER + GOPHERS + HTTP + HTTPS + IMAP + IMAPS + LDAP + LDAPS + MQTT + POP3 + POP3S + RTMP + RTMPE + RTMPS + RTMPT + RTMPTE + RTMPTS + RTSP + SCP + SFTP + SMB + SMBS + SMTP + SMTPS + TELNET + TFTP + WS + WSS + . + Available as of PHP 8.3.0 and cURL 7.85.0. + + + + + + CURLOPT_PROXY + (int) + + + + A string with the HTTP proxy to tunnel requests through. + This should be the hostname, the dotted numerical IP address + or a numerical IPv6 address written within [brackets]. + Available as of cURL 7.1.0. + + + + + + CURLOPT_PROXYAUTH + (int) + + + + A bitmask of the HTTP authentication method(s) + (CURLAUTH_* constants) + to use for the proxy connection. + For proxy authentication, only CURLAUTH_BASIC and + CURLAUTH_NTLM are currently supported. + Defaults to CURLAUTH_BASIC. + Available as of cURL 7.10.7. + + + + + + CURLOPT_PROXYHEADER + (int) + + + + An array of custom HTTP header strings to pass to proxies. + Available as of PHP 7.0.7 and cURL 7.37.0. + + + + + + CURLOPT_PROXYPASSWORD + (int) + + + + Set a string with the password to be used for authentication with the proxy. + Available as of cURL 7.19.1. + + + + + + CURLOPT_PROXYPORT + (int) + + + + An int with the port number of the proxy to connect to. + This port number can also be set in CURLOPT_PROXY. + Setting this to zero makes cURL use the default proxy port number + or the port number specified in the proxy URL string. + Available as of cURL 7.1.0. + + + + + + CURLOPT_PROXYTYPE + (int) + + + + Sets the type of the proxy to one of the + CURLPROXY_* constants. + Defaults to CURLPROXY_HTTP. + Available as of cURL 7.10. + + + + + + CURLOPT_PROXYUSERNAME + (int) + + + + Set a string with the username to be used for authentication with the proxy. + Available as of cURL 7.19.1. + + + + + + CURLOPT_PROXYUSERPWD + (int) + + + + A string with a username and password formatted as + [username]:[password] to use for the + connection to the proxy. + Available as of cURL 7.1.0. + + + + + + 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 cURL'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) + + + + A string with 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 cURL's cacert bundle is assumed + to be stored. + Available as of PHP 8.2.0 and cURL 7.77.0. + + + + + + CURLOPT_PROXY_CAPATH + (int) + + + + A string with 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 to a string with 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 string. + Available as of PHP 8.1.0 and cURL 7.71.0. + + + + + + CURLOPT_PROXY_ISSUERCERT_BLOB + (int) + + + + A string with the proxy issuer SSL certificate. + 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. + A passphrase is not needed to load a certificate + but one is needed to load a 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 the pinned public key + which is expected to be in a PEM + or DER file format. + 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) + + + + A string with 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) + + + + A string with the file name of the 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 + used for authentication as it is named in the security database. + If a file from the current directory is to be used, + it must be prefixed with ./ + in order to avoid confusion with a nickname. + Available as of PHP 7.3.0 and cURL 7.52.0. + + + + + + CURLOPT_PROXY_SSLCERTTYPE + (int) + + + + A string with the format of the 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) + + + + A string with the SSL proxy client certificate. + Available as of PHP 8.1.0 and cURL 7.71.0. + + + + + + CURLOPT_PROXY_SSLKEY + (int) + + + + A string with the file name of the 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 with TLS enabled. + Available as of PHP 7.3.0 and cURL 7.52.0. + + + + + + CURLOPT_PROXY_SSLKEYTYPE + (int) + + + + A string with the format of the private key. + Supported formats are: + + PEM + DER + ENG + . + Available as of PHP 7.3.0 and cURL 7.52.0. + + + + + + CURLOPT_PROXY_SSLKEY_BLOB + (int) + + + + A string with the private key for connecting to the HTTPS proxy. + Available as of PHP 8.1.0 and cURL 7.71.0. + + + + + + CURLOPT_PROXY_SSLVERSION + (int) + + + + Set the preferred HTTPS proxy TLS version to one of the + CURL_SSLVERSION_* + constants. + Defaults to CURL_SSLVERSION_DEFAULT. + + + 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) + + + + A string with a colon-separated list of ciphers + to use for the connection to the HTTPS proxy. + When used with OpenSSL commas and spaces are also acceptable as separators, + and !, - 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 + CURLSSLOPT_* constants. + 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! + Set to 1 in cURL 7.28.0 and earlier as a debug option. + Set to 1 in cURL 7.28.1 to 7.65.3 CURLE_BAD_FUNCTION_ARGUMENT is returned. + As of cURL 7.66.0 1 and 2 is treated as the same value. + Defaults to 2. + In production environments the value of this option should be kept at 2. + Available as of PHP 7.3.0 and cURL 7.52.0. + + + + + + CURLOPT_PROXY_SSL_VERIFYPEER + (int) + + + + Set to &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) + + + + A string with a colon-separated list of ciphers to use for the connection to the TLS 1.3 connection to a proxy. + This option is currently used only when cURL is built to use OpenSSL 1.1.1 or later. + When using a different SSL backend the TLS 1.3 cipher suites can be set + with the CURLOPT_PROXY_SSL_CIPHER_LIST option. + Available as of PHP 7.3.0 and cURL 7.61.0. + + + + + + CURLOPT_PROXY_TLSAUTH_PASSWORD + (int) + + + + A string with 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. + + + Secure Remote Password (SRP) authentication for TLS provides mutual authentication + if both sides have a shared secret. To use TLS-SRP, the + CURLOPT_PROXY_TLSAUTH_USERNAME and + CURLOPT_PROXY_TLSAUTH_PASSWORD options must also be set. + + + 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_PROXY_TRANSFER_MODE + (int) + + + + Set to 1 to set the transfer mode (binary or ASCII) + for FTP transfers done via an HTTP proxy, by appending + type=a or type=i to the URL. + Without this setting or it being set to 0, + CURLOPT_TRANSFERTEXT has no effect + when doing FTP via a proxy. + Defaults to 0. + Available as of cURL 7.18.0. + + + + + + CURLOPT_PUT + (int) + + + + &true; to HTTP PUT a file. The file to PUT must + be set with CURLOPT_READDATA and + CURLOPT_INFILESIZE. + Available as of cURL 7.1.0 and deprecated as of cURL 7.12.1. + + + + + + CURLOPT_QUICK_EXIT + (int) + + + + Set to &true; for cURL to skip cleanup of resources + when recovering from a timeout. + This allows for a swift termination of the cURL process + at the expense of a possible leak of associated resources. + Available as of PHP 8.3.0 and cURL 7.87.0. + + + + + + CURLOPT_QUOTE + (int) + + + + An array of FTP command strings to execute on the server prior to the FTP request. + Available as of cURL 7.1.0. + + + + + + CURLOPT_RANDOM_FILE + (int) + + + + A string with a filename to be used to seed the random number generator for SSL. + Available as of cURL 7.7.0 and deprecated as of cURL 7.84.0. + + + + + + CURLOPT_RANGE + (int) + + + + A string with the 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. + Set to &null; to disable requesting a byte range. + Available as of cURL 7.1.0. + + + + + + CURLOPT_READDATA + (int) + + + + Sets a file pointer resource that will be used by the file read function + set with CURLOPT_READFUNCTION. + Available as of cURL 7.9.7. + + + + + + CURLOPT_READFUNCTION + (int) + + + + A callable with the following signature: + + stringcallback + resourcecurlHandle + resourcestreamResource + intmaxAmountOfDataToRead + + + + curlHandle + + + The cURL handle. + + + + + streamResource + + + Stream resource provided to cURL through the option + CURLOPT_READDATA. + + + + + maxAmountOfDataToRead + + + The maximum amount of data to be read. + + + + + The callback should 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. + Available as of cURL 7.1.0. + + + + + + CURLOPT_REDIR_PROTOCOLS + (int) + + + + Bitmask of CURLPROTO_* values + which limit what protocols cURL may use in a transfer that it follows to in + a redirect when CURLOPT_FOLLOWLOCATION is enabled. + This allows limiting specific transfers to only be allowed to use a subset + of protocols in redirections. + As of cURL 7.19.4, by default cURL will allow all protocols + except for FILE and SCP. + Prior to cURL 7.19.4, cURL would unconditionally follow to all supported protocols. + See also CURLOPT_PROTOCOLS for protocol constant values. + Available as of cURL 7.19.4 and deprecated as of cURL 7.85.0. + + + + + + CURLOPT_REDIR_PROTOCOLS_STR + (int) + + + + Set to a string with a comma separated list + of case insensitive protocol names (URL schemes) + to allow to follow to in a redirect when + CURLOPT_FOLLOWLOCATION is enabled. + Set to ALL to enable all protocols. + As of cURL 7.65.2 it defaults to FTP, + FTPS, HTTP and HTTPS. + From cURL 7.40.0 to 7.65.1, this defaults to all protocols except + FILE, SCP, SMB and + SMBS. + Prior to cURL 7.40.0, this defaults to all protocols except + FILE and SCP. + Available protocols are: + + DICT + FILE + FTP + FTPS + GOPHER + GOPHERS + HTTP + HTTPS + IMAP + IMAPS + LDAP + LDAPS + MQTT + POP3 + POP3S + RTMP + RTMPE + RTMPS + RTMPT + RTMPTE + RTMPTS + RTSP + SCP + SFTP + SMB + SMBS + SMTP + SMTPS + TELNET + TFTP + WS + WSS + . + Available as of PHP 8.3.0 and cURL 7.85.0. + + + + + + CURLOPT_REFERER + (int) + + + + A string with the contents of the Referer: + header to be used in a HTTP request. + Available as of cURL 7.1.0. + + + + + + CURLOPT_REQUEST_TARGET + (int) + + + + A string to use in the upcoming request + instead of the path as extracted from the URL. + Available as of PHP 7.3.0 and cURL 7.55.0. + + + + + + CURLOPT_RESOLVE + (int) + + + + Provide an array of colon-separated strings + with custom addresses for specific host and port pairs in the following format: + + array( + "example.com:80:127.0.0.1", + "example2.com:443:127.0.0.2", + ) + + Available as of cURL 7.21.3. + + + + + + CURLOPT_RESUME_FROM + (int) + + + + The offset, in bytes, to resume a transfer from. + This option accepts any value that can be cast to a valid int. + Available as of cURL 7.1.0. + + + + + + CURLOPT_RETURNTRANSFER + (int) + + + + &true; to return the transfer as a string of the + return value of curl_exec instead of outputting + it directly. + + + + + + CURLOPT_RTSP_CLIENT_CSEQ + (int) + + + + Set an int with the CSEQ number to issue for the next RTSP request. + Useful if the application is resuming a previously broken connection. + The CSEQ increments from this new number henceforth. + Defaults to 0. + Available as of cURL 7.20.0. + + + + + + CURLOPT_RTSP_REQUEST + (int) + + + + Sets the kind of RTSP request to make. + Must be one of the CURL_RTSPREQ_* + constants. + Available as of cURL 7.20.0. + + + + + + CURLOPT_RTSP_SERVER_CSEQ + (int) + + + + Set an int with the CSEQ number to expect + for the next RTSP Server to Client request. + This feature (listening for Server requests) is unimplemented. + Defaults to 0. + Available as of cURL 7.20.0. + + + + + + CURLOPT_RTSP_SESSION_ID + (int) + + + + Set a string with the value of the current RTSP Session ID for the handle. + Once this value is set to any non-&null; value, + cURL returns CURLE_RTSP_SESSION_ERROR + if the ID received from the server does not match. + If set to &null;, cURL automatically sets the ID + the first time the server sets it in a response. + Defaults to &null; + Available as of cURL 7.20.0. + + + + + + CURLOPT_RTSP_STREAM_URI + (int) + + + + Sets a string with the stream URI to operate on. + If not set, cURL defaults to operating on generic server options + by passing * in the place of the RTSP Stream URI. + When working with RTSP, CURLOPT_RTSP_STREAM_URI + indicates what URL to send to the server in the request header + while the CURLOPT_URL indicates + where to make the connection to. + Available as of cURL 7.20.0. + + + + + + CURLOPT_RTSP_TRANSPORT + (int) + + + + Set the Transport: header for this RTSP session. + Available as of cURL 7.20.0. + + + + + + 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) string 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) + + + + A string with 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. + Available as of cURL 7.10. + + + + + + CURLOPT_SOCKS5_AUTH + (int) + + + + The SOCKS5 authentication method(s) to use. The options are: + + CURLAUTH_BASIC + CURLAUTH_GSSAPI + CURLAUTH_NONE + . + When more than one method is set, cURL will poll the server to see + what methods it supports and pick the best one. + 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_SOCKS5_GSSAPI_NEC + (int) + + + + Set to 1 to enable and 0 to disable + the unprotected exchange of the protection mode negotiation + as part of the GSSAPI negotiation. + Available as of cURL 7.19.4. + + + + + + CURLOPT_SOCKS5_GSSAPI_SERVICE + (int) + + + + Set a string holding the name of the SOCKS5 service. + Defaults to rcmd. + Available as of cURL 7.19.4 and deprecated as of cURL 7.49.0. + Use CURLOPT_PROXY_SERVICE_NAME instead. + + + + + + CURLOPT_SSH_AUTH_TYPES + (int) + + + + A bitmask consisting of one or more of the following constants: + + CURLSSH_AUTH_PUBLICKEY + CURLSSH_AUTH_PASSWORD + CURLSSH_AUTH_HOST + CURLSSH_AUTH_KEYBOARD + CURLSSH_AUTH_AGENT + CURLSSH_AUTH_ANY + . + Defaults to CURLSSH_AUTH_ANY. + Available as of cURL 7.16.1. + + + + + + CURLOPT_SSH_COMPRESSION + (int) + + + + &true; to enable, &false; to disable built-in SSH compression. + Note that the server can disregard this request. + Defaults to &false;. + Available as of PHP 7.3.0 and cURL 7.56.0. + + + + + + CURLOPT_SSH_HOSTKEYFUNCTION + (int) + + + + A callable that will be called when SSH host key verification is needed. + The callback must have the following signature: + + intcallback + resourcecurlHandle + intkeyType + stringkey + intkeyLength + + + + curlHandle + + + The cURL handle. + + + + + keyType + + + One of the CURLKHTYPE_* key types. + + + + + key + + + The key to check. + + + + + keyLength + + + The length of the key in bytes. + + + + + This callback overrides CURLOPT_SSH_KNOWNHOSTS. + 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 which should contain the + MD5 checksum of the remote host's public key, and cURL 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) + + + + A string with the 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_KNOWNHOSTS + (int) + + + + Set to the filename of the known_host file to use + which should use the OpenSSH file format as supported by libssh2. + Available as of cURL 7.19.6. + + + + + + CURLOPT_SSH_PRIVATE_KEYFILE + (int) + + + + The file name for a private key. If not used, cURL 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 a public key. If not used, cURL 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. + Available as of cURL 7.1.0. + + + + + + CURLOPT_SSLCERTPASSWD + (int) + + + + The password required to use the + CURLOPT_SSLCERT certificate. + Available as of cURL 7.1.0 and deprecated as of cURL 7.17.0. + + + + + + CURLOPT_SSLCERTTYPE + (int) + + + + A string with the format of the certificate. Supported formats are: + + PEM + DER + ENG + P12 + . + P12 (for PKCS#12-encoded files) is available as of OpenSSL 0.9.3. + Defaults to PEM. + Available as of cURL 7.9.3. + + + + + + CURLOPT_SSLCERT_BLOB + (int) + + + + A string with the SSL client certificate. + Available as of PHP 8.1.0 and cURL 7.71.0. + + + + + + CURLOPT_SSLENGINE + (int) + + + + The string identifier for the crypto engine of the private SSL key + specified in CURLOPT_SSLKEY. + Available as of cURL 7.9.3. + + + + + + CURLOPT_SSLENGINE_DEFAULT + (int) + + + + The string identifier for the crypto engine used for asymmetric crypto + operations. + Available as of cURL 7.9.3. + + + + + + CURLOPT_SSLKEY + (int) + + + + The name of a file containing a private SSL key. + Available as of cURL 7.9.3. + + + + + + CURLOPT_SSLKEYPASSWD + (int) + + + + The secret password needed to use the private SSL key specified in + CURLOPT_SSLKEY. + + + Since this option contains a sensitive password, remember to keep + the PHP script it is contained within safe. + + + Available as of cURL 7.9.3 and deprecated as of cURL 7.17.0. + + + + + + CURLOPT_SSLKEYTYPE + (int) + + + + The key type of the private SSL key specified in + CURLOPT_SSLKEY. Supported key types are: + + PEM + DER + ENG + . + Defaults to PEM. + Available as of cURL 7.9.3. + + + + + + CURLOPT_SSLKEY_BLOB + (int) + + + + A string private key for client cert. + Available as of PHP 8.1.0 and cURL 7.71.0. + + + + + + CURLOPT_SSLVERSION + (int) + + + + One of + the CURL_SSLVERSION_* constants. + + + It is better to not set this option and leave the defaults. + As setting this to + CURL_SSLVERSION_SSLv2 + or + CURL_SSLVERSION_SSLv3 + is very dangerous, given the known + vulnerabilities in SSLv2 and SSLv3. + + + Defaults to CURL_SSLVERSION_DEFAULT. + Available as of cURL 7.1.0. + + + + + + CURLOPT_SSL_CIPHER_LIST + (int) + + + + A colon-separated string of ciphers to use + for the TLS 1.2 (1.1, 1.0) connection. + Available as of cURL 7.9. + + + + + + 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 + cURL 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 + cURL 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, and deprecated as of cURL 7.86.0. + + + + + + CURLOPT_SSL_FALSESTART + (int) + + + + &true; to enable and &false; to disable TLS false start + which is a mode where a TLS client starts sending application data + before verifying the server's Finished message. + 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 + CURLSSLOPT_* constants. + Defaults to none of the bits being set. + Available as of PHP 7.0.7. and cURL 7.25.0. + + + + + + CURLOPT_SSL_SESSIONID_CACHE + (int) + + + + Set to 0 to disable and 1 to enable + SSL session-ID caching. + By default all transfers are done using the cache enabled. + Available as of cURL 7.16.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. + Available as of cURL 7.8.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. + Defaults to &true; as of cURL 7.10. + Default bundle of CA certificates installed as of cURL 7.10. + Available as of cURL 7.4.2. + + + + + + CURLOPT_SSL_VERIFYSTATUS + (int) + + + + &true; to enable and &false; to disable verification of the certificate's status. + Available as of PHP 7.0.7 and cURL 7.41.0. + + + + + + CURLOPT_STDERR + (int) + + + + Accepts a file handle resource pointing to + an alternative location to output errors to instead of + STDERR. + Available as of cURL 7.1.0. + + + + + + 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. + + + + + + CURLOPT_SUPPRESS_CONNECT_HEADERS + (int) + + + + &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. + Defaults to &false;. + Available as of PHP 7.3.0 and cURL 7.54.0. + + + + + + CURLOPT_TCP_FASTOPEN + (int) + + + + &true; to enable and &false; to disable 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. + The maximum number of probes can be set with the CURLOPT_TCP_KEEPCNT + option. + 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_KEEPCNT + (int) + + + + Sets the maximum number of TCP keep-alive probes. + The default is 9. + Available as of PHP 8.4.0 and cURL 8.9.0. + + + + + + CURLOPT_TCP_NODELAY + (int) + + + + &true; to disable TCP's Nagle algorithm, which tries to minimize + the number of small packets on the network. + Defaults to &true;. + Available as of cURL 7.11.2. + + + + + + CURLOPT_TELNETOPTIONS + (int) + + + + Set an array of strings to pass to the telnet negotiations. + The variables should be in the format >option=value<. + cURL supports the options TTYPE, + XDISPLOC and NEW_ENV. + Available as of cURL 7.7.0. + + + + + + CURLOPT_TFTP_BLKSIZE + (int) + + + + Set the blocksize to use for TFTP data transmission. + Valid range is 8-65464 bytes. + The default of 512 bytes is used if this option is not specified. + The specified block size is only used if supported by the remote server. + If the server does not return an option acknowledgment + or returns an option acknowledgment with no block size, + the default of 512 bytes is used. + Available as of cURL 7.19.4. + + + + + + CURLOPT_TFTP_NO_OPTIONS + (int) + + + + &true; to not send TFTP options requests. + Defaults to &false;. + Available as of PHP 7.0.7 and cURL 7.48.0. + + + + + + CURLOPT_TIMECONDITION + (int) + + + + Set 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. + Prior to cURL 7.46.0 the default was + CURL_TIMECOND_IFMODSINCE. + Available as of cURL 7.1.0. + + + + + + CURLOPT_TIMEOUT + (int) + + + + The maximum number of seconds to allow cURL functions to execute. + Defaults to 0, meaning that functions never time out during transfer. + Available as of cURL 7.1.0. + + + + + + CURLOPT_TIMEOUT_MS + (int) + + + + The maximum number of milliseconds to allow cURL functions to + execute. + If cURL 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. + Defaults to 0, meaning that functions never time out during transfer. + 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. + Defaults to 0. + Available as of cURL 7.1.0. + + + + + + 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) + + + + A string with a colon-separated list of ciphers + to use for the connection to the TLS 1.3 connection. + This option is currently used only when cURL is built to use OpenSSL 1.1.1 or later. + When using a different SSL backend the TLS 1.3 cipher suites can be set + with the CURLOPT_SSL_CIPHER_LIST option. + Available as of PHP 7.3.0 and cURL 7.61.0. + + + + + + CURLOPT_TLSAUTH_PASSWORD + (int) + + + + Set a password to use for the TLS authentication method specified + with the CURLOPT_TLSAUTH_TYPE option. Requires that + the CURLOPT_TLSAUTH_USERNAME option also be set. + This feature relies on TLS SRP which does not work with TLS 1.3. + Available as of cURL 7.21.4. + + + + + + CURLOPT_TLSAUTH_TYPE + (int) + + + + Set a string with the method of the TLS authentication. + Supported method is SRP + (TLS Secure Remote Password authentication). + Available as of cURL 7.21.4. + + + + + + CURLOPT_TLSAUTH_USERNAME + (int) + + + + Set a string with the username to use for the TLS authentication method + specified with the CURLOPT_TLSAUTH_TYPE option. + Requires that the CURLOPT_TLSAUTH_PASSWORD option + also be set. + This feature relies on TLS SRP which does not work with TLS 1.3. + Available as of cURL 7.21.4. + + + + + + CURLOPT_TRANSFER_ENCODING + (int) + + + + Set to 1 to enable and 0 to disable + requesting compressed Transfer Encoding in the outgoing + HTTP request. If the server responds with a compressed + Transfer Encoding, + cURL will automatically uncompress it on reception. + Defaults to 0. + Available as of cURL 7.21.6. + + + + + + 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. + Defaults to &false;. + Available as of cURL 7.1.1. + + + + + + CURLOPT_UNIX_SOCKET_PATH + (int) + + + + Enables the use of Unix domain sockets as connection endpoint and + sets the path to the given string. + Set to &null; to disable. + Defaults to &null;. + 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. + Defaults to &false;. + Available as of cURL 7.10.4. + + + + + + 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. + Defaults to CURL_UPKEEP_INTERVAL_DEFAULT + which is currently 60 seconds. + Available as of PHP 8.2.0 and cURL 7.62.0. + + + + + + CURLOPT_UPLOAD + (int) + + + + &true; to prepare for and perform an upload. + Defaults to &false;. + Available as of cURL 7.1.0. + + + + + + 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. + Available as of cURL 7.1.0. + + + + + + CURLOPT_USE_SSL + (int) + + + + Sets the desired level of SSL/TLS for the transfer + when using FTP, SMTP, POP3, IMAP, etc. + These are all protocols that start out plain text + and get "upgraded" to SSL using the STARTTLS command. + Set to one of the + CURLUSESSL_* constants. + Available as of cURL 7.17.0. + + + + + + CURLOPT_USERAGENT + (int) + + + + The contents of the User-Agent: header to be + used in a HTTP request. + Available as of cURL 7.1.0. + + + + + + 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. + Available as cURL 7.1.0. + + + + + + CURLOPT_VERBOSE + (int) + + + + &true; to output verbose information. Writes + output to STDERR, or the file specified using + CURLOPT_STDERR. + Defaults to &false;. + Available as of cURL 7.1.0. + + + + + + CURLOPT_WILDCARDMATCH + (int) + + + + Set to 1 to transfer multiple files + according to a filename pattern. + The pattern can be specified as part of the + CURLOPT_URL option, + using an fnmatch-like pattern (Shell Pattern Matching) + in the last part of URL (filename). + Available as of cURL 7.21.0. + + + + + + CURLOPT_WRITEFUNCTION + (int) + + + + A callable with the following signature: + + intcallback + resourcecurlHandle + stringdata + + + + curlHandle + + + The cURL handle. + + + + + data + + + The data to be written. + + + + + The data must be saved by the callback + and the callback must return the exact number of bytes written + or the transfer will be aborted with an error. + Available as of cURL 7.1.0. + + + + + + CURLOPT_WRITEHEADER + (int) + + + + Accepts a file handle resource to the file that the header part of the transfer is written to. + Available as of cURL 7.1.0. + + + + + + CURLOPT_WS_OPTIONS + (int) + + + + Accepts a bitmask setting WebSocket behavior options. + The only available option is CURLWS_RAW_MODE. + Defaults to 0. + Available as of PHP 8.3.0 and cURL 7.86.0. + + + + + + CURLOPT_XFERINFOFUNCTION + (int) + + + + A callable with the following signature: + + intcallback + resourcecurlHandle + intbytesToDownload + intbytesDownloaded + intbytesToUpload + intbytesUploaded + + + + curlHandle + + + The cURL handle. + + + + + bytesToDownload + + + The total number of bytes expected to be downloaded in this transfer. + + + + + bytesDownloaded + + + The number of bytes downloaded so far. + + + + + bytesToUpload + + + The total number of bytes expected to be uploaded in this transfer. + + + + + bytesUploaded + + + The number of bytes uploaded so far. + + + + + Return 1 to abort the transfer + and set a CURLE_ABORTED_BY_CALLBACK error. + Available as of PHP 8.2.0 and cURL 7.32.0. + + + + + + CURLOPT_SERVER_RESPONSE_TIMEOUT + (int) + + + + A timeout in seconds cURL will wait for a response from an + FTP, SFTP, IMAP, + SCP, SMTP, or a POP3 server. + This option replaces the existing CURLOPT_FTP_RESPONSE_TIMEOUT + option which is deprecated in cURL 7.85.0. + Available as of PHP 8.4.0. + + + + + + CURLOPT_XOAUTH2_BEARER + (int) + + + + Specifies the OAuth 2.0 access token. + Set to &null; to disable. + Defaults to &null;. + Available as of PHP 7.0.7 and cURL 7.33.0. + + + + + + CURLOPT_PREREQFUNCTION + (int) + + + + A callable with the following signature that gets called after the + connection is established, but before the request payload (for example, the + GET/POST/DELETE request of an HTTP connection) is sent, and can be used to abort + or allow the connection depending on the source and destination IP address and + port numbers: + + intcallback + CurlHandlecurlHandle + stringdestination_ip + stringlocal_ip + intdestination_port + intlocal_port + + + + curlHandle + + + The cURL handle. + + + + + destination_ip + + + The primary IP of the remote server established with this connection. + For FTP, this is the IP for the control connection. + IPv6 addresses are represented without surrounding brackets. + + + + + local_ip + + + The originating IP for this connection. + IPv6 addresses are represented without surrounding brackets. + + + + + destination_port + + + The primary port number on the remote server established with this connection. + For FTP, this is the port for the control connection. + This can be a TCP or a UDP port number depending on the protocol. + + + + + local_port + + + The originating port number for this connection. + This can be a TCP or a UDP port number depending on the protocol. + + + + + Return CURL_PREREQFUNC_OK to allow the request, or + CURL_PREREQFUNC_ABORT to abort the transfer. + Available as of PHP 8.4.0 and cURL 7.80.0. + + + + + + CURLOPT_DEBUGFUNCTION + (int) + + + + Available as of PHP 8.4.0. + This option requires CURLOPT_VERBOSE option enabled. + A callable to replace the standard cURL verbose output. + This callback gets called during various stages of the request with verbose debug information. + The callback should match the following signature: + + voidcallback + CurlHandlecurlHandle + inttype + stringdata + + + + curlHandle + + + The cURL handle. + + + + + type + + + One of the following constants indicating the type of the data value: + + + + + CURLINFO_TEXT + (int) + + + + Informational text. + + + + + + CURLINFO_HEADER_IN + (int) + + + + Header (or header-like) data received from the peer. + + + + + + CURLINFO_HEADER_OUT + (int) + + + + Header (or header-like) data sent to the peer. + + + + + + CURLINFO_DATA_IN + (int) + + + + Unprocessed protocol data received from the peer. + Even if the data is encoded or compressed, it is not provided decoded nor decompressed to this callback. + + + + + + CURLINFO_DATA_OUT + (int) + + + + Protocol data sent to the peer. + + + + + + CURLINFO_SSL_DATA_IN + (int) + + + + SSL/TLS (binary) data received from the peer. + + + + + + CURLINFO_SSL_DATA_OUT + (int) + + + + SSL/TLS (binary) data sent to the peer. + + + + + + + + data + + + Verbose debug data of the type indicate by the type parameter. + + + + + + + + From 252d0cbb5c7333e0f9d04b3f46bef80bc856e362 Mon Sep 17 00:00:00 2001 From: nsfisis Date: Mon, 12 May 2025 01:26:01 +0900 Subject: [PATCH 2/6] =?UTF-8?q?reference/curl/constants=5Fcurl=5Fsetopt.xm?= =?UTF-8?q?l=20=E3=82=92=E7=BF=BB=E8=A8=B3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- reference/curl/constants_curl_setopt.xml | 2689 +++++++++++----------- 1 file changed, 1300 insertions(+), 1389 deletions(-) diff --git a/reference/curl/constants_curl_setopt.xml b/reference/curl/constants_curl_setopt.xml index 8f3c4fe12d..45b89bbf7c 100644 --- a/reference/curl/constants_curl_setopt.xml +++ b/reference/curl/constants_curl_setopt.xml @@ -1,6 +1,6 @@ - + <function>curl_setopt</function> @@ -10,13 +10,12 @@ - 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. + ホストへの TCP 接続を確立する代わりに抽象 Unix ドメインソケットを使うようにし、 + そのパスを指定した string へと設定します。 + このオプションの使い方は CURLOPT_UNIX_SOCKET_PATH と同じです。 + これら 2 つのオプションは値を保持する領域を共有しているため、 + ハンドルごとに設定できるのはいずれか 1 つだけです。 + PHP 7.3.0 以降かつ cURL 7.53.0 以降で利用可能です。 @@ -27,11 +26,11 @@ - Sets a string with the contents - of the Accept-Encoding: header sent in an HTTP request. - Set to &null; to disable sending the Accept-Encoding: header. - Defaults to &null;. - Available as of cURL 7.21.6. + HTTP リクエストの中で送られる Accept-Encoding: ヘッダーの内容を + string で指定します。 + &null; をセットすると、Accept-Encoding: ヘッダーの送信を無効にします。 + デフォルト値は &null; です。 + cURL 7.21.6 以降で利用可能です。 @@ -42,11 +41,11 @@ - The maximum number of milliseconds to wait for a server - to connect back to cURL when an active FTP connection is used. - This option accepts any value that can be cast to a valid int. - Defaults to 60000 milliseconds. - Available as of cURL 7.24.0. + アクティブな FTP 接続を使用している場合に、 + cURL がサーバーからの接続を待機する最大ミリ秒数を指定します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 60000 ミリ秒です。 + cURL 7.24.0 以降で利用可能です。 @@ -57,10 +56,10 @@ - The scope id value to use when connecting to IPv6 addresses. - This option accepts any value that can be cast to a valid int. - Defaults to 0. - Available as of cURL 7.19.0. + IPv6 アドレスに接続する際に使用するスコープ ID の値を指定します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 0 です。 + cURL 7.19.0 以降で利用可能です。 @@ -71,10 +70,11 @@ - Pass a string with 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. + cURL が Alt-Svc のキャッシュファイルとして使用するファイルの名前を string で指定します。 + 既存のキャッシュ内容をこのファイルから読み込んだり、転送後にキャッシュをこのファイルへ書き戻したりできます。 + ただし、CURLOPT_ALTSVC_CTRL に CURLALTSVC_READONLYFILE が指定されている場合、 + 書き込みはできません。 + PHP 8.2.0 以降かつ cURL 7.64.1 以降で利用可能です。 @@ -85,14 +85,13 @@ - 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. - Set to any of the - CURLALTSVC_* constants. - Defaults to Alt-Svc handling being disabled. - Available as of PHP 8.2.0 and cURL 7.64.1. + このハンドルを使う転送において、cURL が Alt-Svc をどう処理するかを指示するために、 + 適切な機能セットのビットマスクを設定します。cURL は HTTPS 経由でのみ Alt-Svc ヘッダーを受け付けます。 + また、代替オリジンが HTTPS で適切にホストされている場合にのみ、代替オリジンへのリクエストを最後まで実行します。 + いずれかのビットを設定すると alt-svc エンジンが有効になります。 + CURLALTSVC_* 定数のいずれかを設定します。 + デフォルトでは Alt-Svc 処理は無効です。 + PHP 8.2.0 以降かつ cURL 7.64.1 以降で利用可能です。 @@ -103,10 +102,10 @@ - Setting this option to 1 will cause FTP uploads - to append to the remote file instead of overwriting it. - Defaults to 0. - Available as of cURL 7.17.0. + このオプションを 1 に設定すると、FTP アップロード時に + リモートファイルを上書きするのではなく、末尾に追加するようになります。 + デフォルト値は 0 です。 + cURL 7.17.0 以降で利用可能です。 @@ -117,10 +116,10 @@ - &true; to automatically set the Referer: field in - requests where it follows a Location: redirect. - Defaults to 0. - Available as of cURL 7.1.0. + &true; を指定すると、リクエストが Location: のリダイレクトによるものである場合、 + 自動的に Referer: ヘッダーを設定します。 + デフォルト値は 0 です。 + cURL 7.1.0 以降で利用可能です。 @@ -131,10 +130,10 @@ - Provides AWS V4 signature authentication on HTTP(S) header as a string. - 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. + AWS V4 署名認証を HTTP(S) ヘッダーに string として指定します。 + このオプションは、CURLOPT_HTTPAUTH で設定された + 他の認証方法を上書きします。これと他の認証方法を組み合わせることはできません。 + PHP 8.2.0 以降かつ cURL 7.75.0 以降で利用可能です。 @@ -145,8 +144,8 @@ - This constant is no longer used as of PHP 5.5.0. - Deprecated as of PHP 8.4.0. + この定数は PHP 5.5.0 以降は用いられていません。 + PHP 8.4.0 以降は非推奨となっています。 @@ -157,11 +156,11 @@ - The size of the buffer to use for each read. There is no guarantee - this request will be fulfilled, however. - This option accepts any value that can be cast to a valid int. - Defaults to CURL_MAX_WRITE_SIZE (currently, 16kB). - Available as of cURL 7.10. + 各読込で使用するバッファサイズを設定します。 + ただし、必ずしも指定した値が使われるとは限りません。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は CURL_MAX_WRITE_SIZE (現在は 16kB) です。 + cURL 7.10 以降で利用可能です。 @@ -172,10 +171,10 @@ - A string with 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. - Available as of cURL 7.4.2. + 相手を検証するための証明書を格納したファイル名を string で指定します。 + このオプションは、CURLOPT_SSL_VERIFYPEER と組み合わせて用いた場合のみ意味を持ちます。 + 絶対パスを指定する必要があるかもしれません。 + cURL 7.4.2 以降で利用可能です。 @@ -186,9 +185,9 @@ - A string with 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. + 相手を検証するための証明書を格納した PEM ファイル名を string で指定します。 + このオプションは CURLOPT_CAINFO を上書きします。 + PHP 8.2.0 以降かつ cURL 7.77.0 以降で利用可能です。 @@ -199,9 +198,9 @@ - A string with a directory that holds multiple CA certificates. - Use this option alongside CURLOPT_SSL_VERIFYPEER. - Available as of cURL 7.9.8. + CA 証明書を格納したディレクトリを string で指定します。 + CURLOPT_SSL_VERIFYPEER と一緒に使用してください。 + cURL 7.9.8 以降で利用可能です。 @@ -212,11 +211,11 @@ - Sets the maximum time in seconds any in memory cached CA certificate store - may be kept and reused for new connections. - This option accepts any value that can be cast to a valid int. - Defaults to 86400 (24 hours). - Available as of PHP 8.3.0 and cURL 7.87.0 + CA 証明書ストアのインメモリキャッシュが保持され、新しい接続に再利用される + 最大時間を秒単位で指定します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 86400 (24 時間) です。 + PHP 8.3.0 以降かつ cURL 7.87.0 以降で利用可能です。 @@ -227,11 +226,11 @@ - &true; to output SSL certification information to STDERR - on secure transfers. - Requires CURLOPT_VERBOSE to be on to have an effect. - Defaults to &false;. - Available as of cURL 7.19.1. + &true; に設定すると、暗号化された通信の際に + SSL 認証情報を STDERR へ出力します。 + CURLOPT_VERBOSE を有効にしている場合にのみ効果があります。 + デフォルト値は &false; です。 + cURL 7.19.1 以降で利用可能です。 @@ -242,11 +241,11 @@ - The number of seconds to wait while trying to connect. Use 0 to - wait indefinitely. - This option accepts any value that can be cast to a valid int. - Defaults to 300. - Available as of cURL 7.7.0. + 接続するまでの最大待機秒数を指定します。 + 0 を指定するといつまでも待機します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 300 です。 + cURL 7.7.0 以降で利用可能です。 @@ -257,14 +256,14 @@ - The number of milliseconds to wait while trying to connect. - Use 0 to wait indefinitely. - If cURL 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. - This option accepts any value that can be cast to a valid int. - Defaults to 300000. - Available as of cURL 7.16.2. + 接続するまでの最大待機ミリ秒数を指定します。 + 0 を指定するといつまでも待機します。 + cURL がシステム標準の名前解決器を使うようにビルドされている場合、 + 接続のその部分のタイムアウトは秒精度となり、 + 指定できる最小の待機時間も 1 秒になります。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 300000 です。 + cURL 7.16.2 以降で利用可能です。 @@ -275,11 +274,11 @@ - &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. - Defaults to &false;. - Available as of cURL 7.15.2. + &true; を指定すると、必要なプロキシの認証をおこなって接続を確立するだけで、 + データ転送をおこなわなくなります。このオプションは + HTTP、SMTP、POP3 で実装されています。 + デフォルト値は &false; です。 + cURL 7.15.2 以降で利用可能です。 @@ -290,10 +289,10 @@ - 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. + URL のホストとポートの代わりに、指定したホストとポートに接続します。 + HOST:PORT:CONNECT-TO-HOST:CONNECT-TO-PORT の形式の + string を array で受け付けます。 + PHP 7.0.7 以降かつ cURL 7.49.0 以降で利用可能です。 @@ -304,10 +303,9 @@ - A string with 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). - Available as of cURL 7.1.0. + HTTP リクエストの中で使われる Cookie: ヘッダーの内容を string で指定します。 + 複数のクッキーを指定する場合はセミコロンとスペースで区切ります (例: fruit=apple; colour=red)。 + cURL 7.1.0 以降で利用可能です。 @@ -318,11 +316,11 @@ - A string with 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. - Available as of cURL 7.1.0. + クッキーデータを格納したファイル名を string で指定します。 + クッキーファイルは Netscape 形式か、通常の HTTP スタイルのヘッダーをそのままファイルにダンプしたものです。 + ファイル名が空の string の場合、クッキーは読み込まれませんが、クッキーの処理は + おこなわれます。 + cURL 7.1.0 以降で利用可能です。 @@ -333,15 +331,15 @@ - A string with the name of a file to save all internal cookies to when - the handle's destructor is called. - Available as of cURL 7.9.0. + cURL が保持しているすべてのクッキーを保存するファイル名を string で指定します。 + 書込は cURL ハンドルが破棄されたときにおこなわれます。 + cURL 7.9.0 以降で利用可能です。 - 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, run curl_setopt($ch, CURLOPT_COOKIELIST, "FLUSH");. + PHP 8.0.0 以降、curl_close は + 何もしなくなり、ハンドルを破棄 しなく なりました。 + ハンドラが自動的に破棄されるよりも前にクッキーを書き出す必要がある場合、 + curl_setopt($ch, CURLOPT_COOKIELIST, "FLUSH"); を実行してください。 @@ -354,27 +352,27 @@ - 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. + string で指定されたクッキーを内部のクッキーストアに追加します。 + この文字列は Nescape/Mozilla 形式の単一行、または通常の HTTP スタイルの Set-Cookie ヘッダーです。 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 + は CURLOPT_COOKIEJAR で指定されたファイルにすべてのクッキーを書き出し RELOAD - loads all cookies from the files specified by CURLOPT_COOKIEFILE + は CURLOPT_COOKIEFILE で指定されたファイルからすべてのクッキーを読み込みます - . - Available as of cURL 7.14.1. + 。 + cURL 7.14.1 以降で利用可能です。 @@ -385,13 +383,13 @@ - &true; to mark this as a new cookie "session". It will force cURL - to ignore all cookies it is about to load that are "session cookies" - from the previous session. By default, cURL 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. - Available as of cURL 7.9.7. + &true; を指定すると、現在の接続を新しいクッキーの「セッション」とみなします。 + これにより、cURL は以前のセッションから読み込まれる「セッションクッキー」をすべて無視するようになります。 + デフォルトでは、cURL はセッションクッキーかどうかに関わらず、 + すべてのクッキーを常に保存し読み込みます。 + セッションクッキーは、有効期限がなく + この「セッション」中でのみ有効であることが意図されたクッキーです。 + cURL 7.9.7 以降で利用可能です。 @@ -402,9 +400,9 @@ - &true; to convert Unix newlines to CRLF newlines - on transfers. - Available as of cURL 7.1.0. + &true; を指定すると、Unix の改行コードを CRLF 改行コードに変換して + 送ります。 + cURL 7.1.0 以降で利用可能です。 @@ -415,21 +413,17 @@ - Pass a string naming a file with the concatenation of - CRL (Certificate Revocation List) (in PEM format) - to use in the certificate validation that occurs during the SSL exchange. - When cURL is built to use GnuTLS, - there is no way to influence the use of CRL passed - to help in the verification process. - When cURL is built with OpenSSL support, - X509_V_FLAG_CRL_CHECK - and X509_V_FLAG_CRL_CHECK_ALL are both set, - requiring CRL check against all the elements of the certificate chain - if a CRL file is passed. - Also note that CURLOPT_CRLFILE implies - CURLSSLOPT_NO_PARTIALCHAIN - as of cURL 7.71.0 due to an OpenSSL bug. - Available as of cURL 7.19.0. + SSL 交換中の証明書検証で使用する CRL (Certificate Revocation List; 証明書失効リスト) (PEM 形式) を + 記載したファイルの名前を string で指定します。 + cURL が GnuTLS を使うようにビルドされている場合、 + 渡した CRL が検証処理でどう使われるかを制御することはできません。 + cURL が OpenSSL を使うようにビルドされている場合、 + X509_V_FLAG_CRL_CHECK と + X509_V_FLAG_CRL_CHECK_ALL の両方が設定され、 + CRL ファイルを渡したなら証明書チェーンの全要素に対して CRL のチェックが必要になります。 + また、CURLOPT_CRLFILE は OpenSSL のバグのため、 + cURL 7.71.0 以降では CURLSSLOPT_NO_PARTIALCHAIN を暗示することに注意してください。 + cURL 7.19.0 以降で利用可能です。 @@ -440,21 +434,20 @@ - 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. - This option accepts a string or &null;. - Available as of cURL 7.1.0. + HTTP リクエストを送る際、GET や HEAD + の代わりに用いるカスタムのリクエストメソッドを指定します。 + DELETE や、その他マイナーな HTTP リクエストを送りたいときに便利です。 + 有効な値は、GET、POST、 + CONNECT などといったものです。 + つまり、ここに完全な HTTP のリクエスト行を入れてはいけません。 + 例えば、GET /index.html HTTP/1.0\r\n\r\n を + 入れるのは誤りです。 + このオプションは string ないし &null; を受け取ります。 + cURL 7.1.0 以降で利用可能です。 - Don't do this without making sure the server supports the custom - request method first. + サーバーがそのカスタムリクエストメソッドをサポートしていることを確かめるまでは + 使わないでください。 @@ -467,8 +460,8 @@ - A string with 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. + URL がスキーム名を持たない場合に使用するデフォルトのプロトコルを string で指定します。 + PHP 7.0.7 以降かつ cURL 7.45.0 以降で利用可能です。 @@ -479,16 +472,16 @@ - Setting this option to 1 will have different effects - based on the protocol it is used with. - FTP and SFTP based URLs will list only the names of files in a directory. - POP3 will list the email message or messages on the POP3 server. - For FILE, this option has no effect - as directories are always listed in this mode. - Using this option with CURLOPT_WILDCARDMATCH - will prevent the latter from having any effect. - Defaults to 0. - Available as of cURL 7.17.0. + このオプションに 1 を設定すると、 + 使っているプロトコルによって異なる動作をします。 + FTP および SFTP ベースの URL では、ディレクトリ内のファイル名のみを列挙します。 + POP3 では、POP3 サーバー上の電子メールメッセージを列挙します。 + FILE に対してこのオプションは効果がありません。 + このモードではディレクトリは常に列挙されるからです。 + このオプションを CURLOPT_WILDCARDMATCH と一緒に使うと、 + 後者の効果がなくなります。 + デフォルト値は 0 です。 + cURL 7.17.0 以降で利用可能です。 @@ -499,9 +492,9 @@ - &true; to not allow URLs that include a username. - Usernames are allowed by default. - Available as of PHP 7.3.0 and cURL 7.61.0. + &true; を指定すると、URL にユーザー名を含められなくなります。 + デフォルトではユーザー名を含められます。 + PHP 7.3.0 以降かつ cURL 7.61.0 以降で利用可能です。 @@ -512,10 +505,10 @@ - The number of seconds to keep DNS entries in memory. This - option is set to 120 (2 minutes) by default. - This option accepts any value that can be cast to a valid int. - Available as of cURL 7.9.3. + DNS のエントリーをメモリ上に保持する秒数を指定します。 + このオプションは、デフォルトで 120 (2分) に設定されています。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + cURL 7.9.3 以降で利用可能です。 @@ -526,10 +519,10 @@ - Set the name of the network interface that the DNS resolver should bind to. - This must be an interface name (not an address). - This option accepts a string or &null;. - Available as of PHP 7.0.7 and cURL 7.33.0 + DNS 解決器がバインドされているネットワークインターフェース名を指定します。 + アドレスではなくインターフェース名を指定する必要があります。 + このオプションは string ないし &null; を受け取ります。 + PHP 7.0.7 以降かつ cURL 7.33.0 以降で利用可能です。 @@ -540,10 +533,10 @@ - Set the local IPv4 address that the resolver should bind to. - The argument should contain a single numerical IPv4 address. - This option accepts a string or &null;. - Available as of PHP 7.0.7 and cURL 7.33.0. + 名前解決器がバインドされているローカル IPv4 アドレスを指定します。 + この引数は単一の数値 IPv4 アドレスを含んでいる必要があります。 + このオプションは string ないし &null; を受け取ります。 + PHP 7.0.7 以降かつ cURL 7.33.0 以降で利用可能です。 @@ -554,10 +547,10 @@ - Set the local IPv6 address that the resolver should bind to. - The argument should contain a single numerical IPv6 address. - This option accepts a string or &null;. - Available as of PHP 7.0.7 and cURL 7.33.0. + 名前解決器がバインドされているローカル IPv5 アドレスを指定します。 + この引数は単一の数値 IPv6 アドレスを含んでいる必要があります。 + このオプションは string ないし &null; を受け取ります。 + PHP 7.0.7 以降かつ cURL 7.33.0 以降で利用可能です。 @@ -568,10 +561,10 @@ - Pass a string with a comma-separated list of DNS servers to be used - instead of the system default - (e.g.: 192.168.1.100,192.168.1.101:8080). - Available as of cURL 7.24.0. + システムのデフォルト DNS サーバーの代わりに使用する DNS サーバーのリストを + コンマ区切りの string で指定します + (例: 192.168.1.100,192.168.1.101:8080)。 + cURL 7.24.0 以降で利用可能です。 @@ -582,10 +575,10 @@ - &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. + &true; を指定すると、ドメイン名が複数の IP アドレスへと解決されたとき、 + アドレスをランダムな順番で使うために、返却されるアドレスの順序がシャッフルされます。 + IPv4 が IPv6 より優先して使われたり、あるいはその逆になったりする可能性があります。 + PHP 7.3.0 以降かつ cURL 7.60.0 以降で利用可能です。 @@ -596,11 +589,12 @@ - &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.). - Available as of cURL 7.9.3 and deprecated as of cURL 7.11.1. - As of PHP 8.4, this option no longer has any effect. + &true; を指定すると、グローバル DNS キャッシュを使うようになります。 + このオプションはスレッドセーフではありません。 + PHP がシングルスレッド用にビルドされている場合 (CLI、FCGI、Apache2-Prefork 等) に、 + 条件付きでデフォルトで有効化されます。 + cURL 7.9.3 以降で利用可能ですが、cURL 7.11.1 以降は非推奨となりました。 + PHP 8.4 以降は、このオプションを指定しても何も起きなくなりました。 @@ -611,8 +605,8 @@ - Set to 2 to 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. + 2 を指定すると、DNS-over-HTTPS サーバーの SSL 証明書の名前フィールドをホスト名に対して検証します。 + PHP 8.2.0 以降かつ cURL 7.76.0 以降で利用可能です。 @@ -623,9 +617,9 @@ - Set to 1 to enable and 0 to disable - verification of the authenticity of the DNS-over-HTTPS server's SSL certificate. - Available as of PHP 8.2.0 and cURL 7.76.0. + 1 を指定すると、DNS-over-HTTPS サーバーの SSL 証明書の真正性を検証します。 + 0 を指定すると検証を無効化します。 + PHP 8.2.0 以降かつ cURL 7.76.0 以降で利用可能です。 @@ -636,10 +630,10 @@ - Set to 1 to enable and 0 to disable - the verification of 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. + 1 を指定すると、DNS-over-HTTPS サーバーの証明書のステータスを + TLS 拡張の「証明書ステータス要求」(OCSP stapling) を使って検証します。 + 0 を指定すると検証を無効化します。 + PHP 8.2.0 以降かつ cURL 7.76.0 以降で利用可能です。 @@ -650,9 +644,9 @@ - Provides the DNS-over-HTTPS URL. - This option accepts a string or &null;. - Available as of PHP 8.1.0 and cURL 7.62.0. + DNS-over-HTTPS の URL を指定します。 + このオプションは string ないし &null; を受け取ります。 + PHP 8.1.0 以降かつ cURL 7.62.0 以降で利用可能です。 @@ -663,9 +657,9 @@ - Like CURLOPT_RANDOM_FILE, except a filename - to an Entropy Gathering Daemon socket. - Available as of cURL 7.7.0 and deprecated as of cURL 7.84.0. + CURLOPT_RANDOM_FILE と似ていますが、 + Entropy Gathering Daemon ソケットのファイル名を指定します。 + cURL 7.7.0 以降で利用可能ですが、cURL 7.84.0 以降は非推奨となりました。 @@ -676,16 +670,16 @@ - The contents of the Accept-Encoding: header as a string. - This enables decoding of the response. Supported encodings are: + Accept-Encoding: ヘッダーの内容を string で指定します。 + これを指定するとレスポンスをデコードするようになります。サポートされているエンコーディングは、 identity deflate gzip - . - If an empty string is set, - a header containing all supported encoding types is sent. - Available as of cURL 7.10 and deprecated as of cURL 7.21.6. + です。 + 空の string を指定すると、 + サポートされている全エンコーディングタイプを含んだヘッダーが送られます。 + cURL 7.10 以降で利用可能ですが、cURL 7.21.6 以降は非推奨となりました。 @@ -696,10 +690,10 @@ - The timeout for Expect: 100-continue responses in milliseconds. - Defaults to 1000 milliseconds. - This option accepts any value that can be cast to a valid int. - Available as of PHP 7.0.7 and cURL 7.36.0. + Expect: 100-continue レスポンスのタイムアウトをミリ秒で指定します。 + デフォルト値は 1000 ミリ秒です。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + PHP 7.0.7 以降かつ cURL 7.36.0 以降で利用可能です。 @@ -710,10 +704,9 @@ - &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. - Available as of cURL 7.1.0. + &true; を指定すると、返された HTTP コードが 400 以上だったときにエラー情報と共に失敗するようになります。 + デフォルトの挙動では、コードを無視して通常どおりページを返します。 + cURL 7.1.0 以降で利用可能です。 @@ -724,10 +717,9 @@ - Accepts a file handle resource - to the file that the transfer should be written to. - The default is STDOUT (the browser window). - Available as of cURL 7.1.0 and deprecated as of cURL 7.9.7. + 転送データを書き込むファイルのファイルハンドル resource を受け取ります。 + デフォルトは STDOUT (ブラウザウィンドウ) です。 + cURL 7.1.0 以降で利用可能ですが、cURL 7.9.7 以降は非推奨となりました。 @@ -738,11 +730,10 @@ - Set to &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. - Available as of cURL 7.5.0. + &true; を指定すると、リモートのドキュメントの更新日時を取得しようとします。 + その値は、curl_getinfo に + CURLINFO_FILETIME オプションを使うことで取得できます。 + cURL 7.5.0 以降で利用可能です。 @@ -753,8 +744,8 @@ - Pass a callable that will be used for wildcard matching. - The signature of the callback should be: + ワイルドカードのマッチングに用いられる callable を渡します。 + コールバックのシグニチャは以下のとおりです。 intcallback resourcecurlHandle @@ -766,7 +757,7 @@ curlHandle - The cURL handle. + cURL ハンドル。 @@ -774,7 +765,7 @@ pattern - The wildcard pattern. + ワイルドカードパターン。 @@ -782,16 +773,15 @@ string - The string to run the wildcard pattern matching on. + ワイルドカードパターンとマッチしているか判定する string。 - The callback should return - CURL_FNMATCHFUNC_MATCH if pattern matches the string, - CURL_FNMATCHFUNC_NOMATCH if not - or CURL_FNMATCHFUNC_FAIL if an error occurred. - Available as of cURL 7.21.0. + この関数は、パターンが string とマッチしていれば CURL_FNMATCHFUNC_MATCH を、 + していなければ CURL_FNMATCHFUNC_NOMATCH を、 + エラー時は CURL_FNMATCHFUNC_FAIL を返さなければなりません。 + cURL 7.21.0 以降で利用可能です。 @@ -802,12 +792,11 @@ - Set to &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. - Available as of cURL 7.1.0. + &true; を指定すると、サーバーから HTTP ヘッダーの一部として送られた Location: ヘッダーを + 追跡するようになります。 + CURLOPT_MAXREDIRS も合わせてご覧ください。 + この定数は open_basedir が有効になっていると利用できません。 + cURL 7.1.0 以降で利用可能です。 @@ -818,9 +807,9 @@ - Set to &true; to force the connection to explicitly - close when it has finished processing, and not be pooled for reuse. - Available as of cURL 7.7.0. + &true; を指定すると、処理が完了したとき明示的に接続を閉じ、 + 再利用のためにプールしないようになります。 + cURL 7.7.0 以降で利用可能です。 @@ -831,9 +820,9 @@ - Set to &true; to force the use of a new connection - instead of a cached one. - Available as of cURL 7.7.0. + &true; を指定すると、キャッシュされた接続を使う代わりに + 必ず新しい接続を用います。 + cURL 7.7.0 以降で利用可能です。 @@ -844,9 +833,9 @@ - Set to &true; to append to the remote file instead of - overwriting it. - Available as of cURL 7.1.0 and deprecated as of cURL 7.16.4. + &true; を指定すると、リモートのファイルを上書きするのではなく、 + 追記するようになります。 + cURL 7.1.0 以降で利用可能ですが、cURL 7.16.4 以降は非推奨となりました。 @@ -857,11 +846,10 @@ - An alias of - CURLOPT_TRANSFERTEXT. Use that instead. - Available as of cURL 7.1, deprecated as of cURL 7.11.1 - and last available in cURL 7.15.5. - Removed as of PHP 7.3.0. + CURLOPT_TRANSFERTEXT のエイリアスです。そちらを使用してください。 + cURL 7.1 以降で利用可能でしたが、cURL 7.11.1 からは非推奨となっており、 + cURL 7.15.5 を最後に削除されました。 + PHP 7.3.0 で削除されました。 @@ -872,8 +860,8 @@ - Set to &true; to only list the names of an FTP directory. - Available as of cURL 7.1.0 and deprecated as of cURL 7.16.4. + FTP ディレクトリの名前のみを列挙するには &true; を指定します。 + cURL 7.1.0 以降で利用可能ですが、cURL 7.16.4 以降は非推奨となりました。 @@ -884,13 +872,13 @@ - A string 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 system's default IP address. - This option accepts a string or &null;. - Available as of cURL 7.1.0. + FTP の PORT 命令で使用する IP アドレスを string で指定します。 + PORT 命令は、ここで指定した IP アドレスに接続するようリモートサーバーに指示します。 + この string には、単なる IP アドレス、ホスト名、 + ネットワークインターフェース名 (Unix で利用可能)、 + または - (システムのデフォルト IP アドレスを使用する場合) を指定できます。 + このオプションは string ないし &null; を受け取ります。 + cURL 7.1.0 以降で利用可能です。 @@ -901,10 +889,10 @@ - Set the FTP over SSL authentication method (if activated) to any of the - CURLFTPAUTH_* constants. - Defaults to CURLFTPAUTH_DEFAULT. - Available as of cURL 7.12.2. + FTP over SSL の認証方式 (有効化されている場合) を、 + CURLFTPAUTH_* 定数のいずれかに指定します。 + デフォルト値は CURLFTPAUTH_DEFAULT です。 + cURL 7.12.2 以降で利用可能です。 @@ -915,12 +903,12 @@ - Pass a string that will be sent as account information over FTP - (using the ACCT command) after username and password has been provided - to the server. - Set to &null; to disable sending the account information. - Defaults to &null;. - Available as of cURL 7.13.0. + ユーザー名とパスワードがサーバーに渡された後、 + FTP 上で (ACCT コマンドを用いて) アカウント情報として送信される + string を設定します。 + &null; を指定すると、アカウント情報の送信が無効化されます。 + デフォルト値は &null; です。 + cURL 7.13.0 以降で利用可能です。 @@ -931,9 +919,9 @@ - Pass a string that will be used to try to authenticate over FTP - if the USER/PASS negotiation fails. - Available as of cURL 7.15.5. + USER/PASS ネゴシエーションが失敗した場合に + FTP での認証を試行するのに使われる string を指定します。 + cURL 7.15.5 以降で利用可能です。 @@ -944,9 +932,9 @@ - Set to &true; to create missing directories when an FTP operation - encounters a path that currently doesn't exist. - Available as of cURL 7.10.7. + &true; を指定すると、FTP の操作で現在存在しないパスに遭遇した場合に + 不足しているディレクトリを作成します。 + cURL 7.10.7 以降で利用可能です。 @@ -957,10 +945,10 @@ - Tell cURL which method to use to reach a file on a FTP(S) server. Possible values are - any of the CURLFTPMETHOD_* constants. - Defaults to CURLFTPMETHOD_MULTICWD. - Available as of cURL 7.15.1. + FTP(S) サーバー上のファイルにアクセスするために使用するメソッドを cURL に指示します。 + 指定できる値は CURLFTPMETHOD_* 定数のいずれかです。 + デフォルト値は CURLFTPMETHOD_MULTICWD です。 + cURL 7.15.1 以降で利用可能です。 @@ -971,12 +959,12 @@ - A timeout in seconds cURL will wait for a response from an FTP server. - This option overrides CURLOPT_TIMEOUT. - This option accepts any value that can be cast to a valid int. - This option name is replaced with CURLOPT_SERVER_RESPONSE_TIMEOUT, - available as of PHP 8.4.0. - Available as of cURL 7.10.8 and deprecated as of cURL 7.85.0. + FTP サーバーからのレスポンスを待機するタイムアウト秒数を指定します。 + このオプションは CURLOPT_TIMEOUT を上書きします。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + このオプション名は PHP 8.4.0 で CURLOPT_SERVER_RESPONSE_TIMEOUT + へ置き換えられました。 + cURL 7.10.8 以降で利用可能ですが、cURL 7.85.0 以降は非推奨となりました。 @@ -987,14 +975,13 @@ - If this option is set to 1 - cURL will not use the IP address the server suggests - in its 227-response to cURL's PASV command - but will use the IP address it used for the connection. - The port number received from the 227-response will not be ignored by cURL. - Defaults to 1 as of cURL 7.74.0 - and 0 prior to that. - Available as of cURL 7.15.0. + このオプションを 1 に設定すると、 + cURL は PASV コマンドに対する 227 レスポンスでサーバーが提案した IP アドレスを使用せず、 + 接続に使用した IP アドレスを使うようになります。 + 227 レスポンスから受信したポート番号は無視されません。 + cURL 7.74.0 以降はデフォルト値が 1 で、 + それ以前は 0 です。 + cURL 7.15.0 以降で利用可能です。 @@ -1005,7 +992,7 @@ - Available as of cURL 7.11.0 and deprecated as of cURL 7.16.4. + cURL 7.11.0 以降で利用可能ですが、cURL 7.16.4 以降は非推奨となりました。 @@ -1016,12 +1003,12 @@ - This option makes cURL use CCC (Clear Command Channel) - which shuts down the SSL/TLS layer after authenticating - making the rest of the control channel communication unencrypted. - Use one of the CURLFTPSSL_CCC_* constants. - Defaults to CURLFTPSSL_CCC_NONE. - Available as of cURL 7.16.1. + このオプションを指定すると、cURL が CCC (Clear Command Channel) を使うようになり、 + 認証後に SSL/TLS レイヤーをシャットダウンして、 + 残りの制御チャネル通信を暗号化しないようになります。 + CURLFTPSSL_CCC_* 定数のいずれかを使用してください。 + デフォルト値は CURLFTPSSL_CCC_NONE です。 + cURL 7.16.1 以降で利用可能です。 @@ -1032,9 +1019,9 @@ - Set to &true; to use EPRT (and LPRT) when doing active FTP downloads. - Set to &false; to disable EPRT and LPRT and use PORT only. - Available as of cURL 7.10.5. + &true; を指定すると、アクティブ FTP ダウンロード時に EPRT (および LPRT) を使用します。 + &false; を指定すると、EPRT と LPRT を無効にし PORT のみを使用します。 + cURL 7.10.5 以降で利用可能です。 @@ -1045,9 +1032,9 @@ - Set to &true; to first try an EPSV command for FTP transfers before reverting back to PASV. - Set to &false; to disable EPSV. - Available as of cURL 7.9.2. + &true; を指定すると、FTP 転送で PASV に戻る前にまず EPSV コマンドを試すようになります。 + &false; を指定すると EPSV が無効になります。 + cURL 7.9.2 以降で利用可能です。 @@ -1058,11 +1045,11 @@ - Set to 1 to send a PRET command - before PASV (and EPSV). - Has no effect when using the active FTP transfers mode. - Defaults to 0. - Available as of cURL 7.20.0. + 1 を指定すると、PASV (および EPSV) の前に + PRET コマンドを送るようになります。 + アクティブ FTP 転送モードを使用している場合効果はありません。 + デフォルト値は 0 です。 + cURL 7.20.0 以降で利用可能です。 @@ -1073,13 +1060,12 @@ - Set to CURLGSSAPI_DELEGATION_FLAG - to allow unconditional GSSAPI credential delegation. - Set to CURLGSSAPI_DELEGATION_POLICY_FLAG - to delegate only if the OK-AS-DELEGATE flag is set - in the service ticket. - Defaults to CURLGSSAPI_DELEGATION_NONE. - Available as of cURL 7.22.0. + CURLGSSAPI_DELEGATION_FLAG を指定すると + 無条件で GSSAPI 資格情報の委任を許可します。 + CURLGSSAPI_DELEGATION_POLICY_FLAG を指定すると + サービスチケットで OK-AS-DELEGATE フラグが設定されている場合のみ委任します。 + デフォルト値は CURLGSSAPI_DELEGATION_NONE です。 + cURL 7.22.0 以降で利用可能です。 @@ -1090,12 +1076,12 @@ - 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. - This option accepts any value that can be cast to a valid int. - Available as of PHP 7.3.0 and cURL 7.59.0 + Happy Eyeballs アルゴリズムにおいて IPv6 に与えられるハンデを指定します。Happy Eyeballs は + デュアルスタックホストに対して IPv4 と IPv6 の両方のアドレスへ接続を試行し、 + このタイムアウトミリ秒の間は IPv6 を優先します。 + デフォルト値は CURL_HET_DEFAULT (現在は 200 ミリ秒) です。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + PHP 7.3.0 以降かつ cURL 7.59.0 以降で利用可能です。 @@ -1106,9 +1092,9 @@ - &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; を指定すると、HAProxy PROXY プロトコル v1 ヘッダーを接続開始時に送信します。 + デフォルトでは送信しません。 + PHP 7.3.0 以降かつ cURL 7.60.0 以降で利用可能です。 @@ -1119,9 +1105,9 @@ - Set to &true; to include the headers in the output sent to the callback - defined by CURLOPT_WRITEFUNCTION. - Available as of cURL 7.1.0. + &true; を指定すると、CURLOPT_WRITEFUNCTION で定義されたコールバックへと渡される出力に + ヘッダーが含まれるようになります。 + cURL 7.1.0 以降で利用可能です。 @@ -1132,7 +1118,7 @@ - A callable with the following signature: + 以下のシグニチャの callable を指定します。 intcallback resourcecurlHandle @@ -1143,7 +1129,7 @@ curlHandle - The cURL handle. + cURL ハンドル。 @@ -1151,13 +1137,13 @@ headerData - The header data which must be written by the callback. + このコールバックが書き込まなければならないヘッダーデータ。 - The callback should return the number of bytes written. - Available as of cURL 7.7.2. + このコールバックは、書き込んだバイト数を返さなければなりません。 + cURL 7.7.2 以降で利用可能です。 @@ -1168,12 +1154,11 @@ - Send HTTP headers to both proxy and host or separately. - Possible values are any of the - CURLHEADER_* constants. - Defaults to CURLHEADER_SEPARATE as of cURL - 7.42.1, and CURLHEADER_UNIFIED prior to that. - Available as of PHP 7.0.7 and cURL 7.37.0. + HTTP ヘッダーをプロキシとホストの両方に送信するか、個別に送信するかを設定します。 + 指定可能な値は CURLHEADER_* 定数のいずれかです。 + cURL 7.42.1 以降のデフォルト値は CURLHEADER_SEPARATE で、 + それ以前では CURLHEADER_UNIFIED です。 + PHP 7.0.7 以降かつ cURL 7.37.0 以降で利用可能です。 @@ -1184,10 +1169,10 @@ - string with HSTS (HTTP Strict Transport Security) cache file name - or &null; to allow HSTS without reading from or writing to any file - and clear the list of files to read HSTS data from. - Available as of PHP 8.2.0 and cURL 7.74.0. + HSTS (HTTP Strict Transport Security) のキャッシュファイル名を string で指定します。 + &null; を指定すると、ファイルの読み書きを行わずに HSTS を行うようになり、 + HSTS データを読み込むファイルのリストがクリアされます。 + PHP 8.2.0 以降かつ cURL 7.74.0 以降で利用可能です。 @@ -1198,9 +1183,9 @@ - Accepts a bitmask of HSTS (HTTP Strict Transport Security) features - defined by the CURLHSTS_* constants. - Available as of PHP 8.2.0 and cURL 7.74.0. + CURLHSTS_* 定数で定義された + HSTS (HTTP Strict Transport Security) 機能のビットマスクを指定できます。 + PHP 8.2.0 以降かつ cURL 7.74.0 以降で利用可能です。 @@ -1211,9 +1196,9 @@ - Whether to allow HTTP/0.9 responses. Defaults to &false; as of cURL 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. + HTTP/0.9 でのレスポンスを許可するかどうかを指定します。cURL 7.66.0 以降のデフォルト値は &false; です。 + それより前のバージョンでは &true; でした。 + PHP 7.3.15 および 7.4.3 以降かつ cURL 7.64.0 以降で利用可能です。 @@ -1224,8 +1209,8 @@ - An array of HTTP 200 responses that will be treated as valid responses and not as errors. - Available as of cURL 7.10.3. + エラーではなく有効なレスポンスとして扱われる HTTP 200 レスポンスの array を指定します。 + cURL 7.10.3 以降で利用可能です。 @@ -1236,7 +1221,7 @@ - A bitmask of HTTP authentication method(s) to use. The options are: + 使用する HTTP 認証方法のビットマスクです。選択肢は以下のとおりです： CURLAUTH_BASIC CURLAUTH_DIGEST @@ -1245,14 +1230,14 @@ CURLAUTH_AWS_SIGV4 CURLAUTH_ANY CURLAUTH_ANYSAFE - . - If more than one method is used, 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. - Available as of cURL 7.10.6. + + 2つ以上の認証方法を指定した場合、cURL はサーバーがどの認証方法をサポートしているか + 問い合わせ、最適なものを選択します。 + CURLAUTH_ANY は全ビットをオンにします。cURL は自動的に + 最も安全だと思われるものを選択します。 + CURLAUTH_ANYSAFE は、CURLAUTH_BASIC を除いた全ビットをオンにします。 + cURL は自動的に最も安全だと思われるものを選択します。 + cURL 7.10.6 以降で利用可能です。 @@ -1263,9 +1248,9 @@ - Set to &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. - Available as of cURL 7.8.1. + &true; を指定すると、HTTP リクエストのメソッドを GET にリセットします。 + デフォルトは GET のため、これが必要なのはリクエストメソッドが変更されていた場合のみです。 + cURL 7.8.1 以降で利用可能です。 @@ -1276,11 +1261,11 @@ - An array of HTTP header fields to set, in the format + HTTP ヘッダーフィールドの array を指定します。各要素の形式は以下のとおりです。 array('Content-type: text/plain', 'Content-length: 100') - Available as of cURL 7.1.0. + cURL 7.1.0 以降で利用可能です。 @@ -1291,8 +1276,8 @@ - &true; to tunnel through a given HTTP proxy. - Available as of cURL 7.3.0. + &true; を指定すると、与えられた HTTP プロキシを通すようになります。 + cURL 7.3.0 以降で利用可能です。 @@ -1303,8 +1288,8 @@ - &false; to get the raw HTTP response body. - Available as of cURL 7.16.2. + &false; を指定すると、生の HTTP レスポンスボディを取得できます。 + cURL 7.16.2 以降で利用可能です。 @@ -1315,12 +1300,12 @@ - If set to 0, transfer decoding is disabled. - If set to 1, transfer decoding is enabled. - cURL does chunked transfer decoding by default - unless this option is set to 0. - Defaults to 1. - Available as of cURL 7.16.2. + 0 を指定するとチャンク転送デコード処理を無効にします。 + 1 を指定するとチャンク転送デコード処理を有効にします。 + このオプションを 0 に設定しない限り、 + cURL はチャンク転送デコード処理をデフォルトで実行します。 + デフォルト値は 1 です。 + cURL 7.16.2 以降で利用可能です。 @@ -1331,10 +1316,9 @@ - Set to one of the - CURL_HTTP_VERSION_* constants - for cURL to use the specified HTTP version. - Available as of cURL 7.9.1. + CURL_HTTP_VERSION_* 定数のいずれかを指定することで、 + cURL に指定した HTTP バージョンを使わせることができます。 + cURL 7.9.1 以降で利用可能です。 @@ -1345,11 +1329,11 @@ - If set to 1, - ignore the Content-Length header in the HTTP response - and ignore asking for or relying on it for FTP transfers. - Defaults to 0. - Available as of cURL 7.14.1. + 1 に設定すると、 + HTTP レスポンスの Content-Length ヘッダーを無視します。 + FTP 転送の際には、それを要求したりそれに依存したりしなくなります。 + デフォルト値は 0 です。 + cURL 7.14.1 以降で利用可能です。 @@ -1360,10 +1344,10 @@ - Accepts a file handle resource - to the file that the transfer should be read from when uploading. - Available as of cURL 7.1.0 and deprecated as of cURL 7.9.7. - Use CURLOPT_READDATA instead. + アップロード時に読み込まれるファイルの + ファイルハンドル resource を指定します。 + cURL 7.1.0 以降で利用可能ですが、cURL 7.9.7 以降は非推奨となりました。 + 代わりに CURLOPT_READDATA を使用してください。 @@ -1374,12 +1358,12 @@ - The expected size, in bytes, of the file when uploading a file to - a remote site. Note that using this option will not stop cURL - from sending more data, as exactly what is sent depends on - CURLOPT_READFUNCTION. - This option accepts any value that can be cast to a valid int. - Available as of cURL 7.1.0. + リモートサイトにファイルをアップロードする際のファイルの予想サイズ (バイト単位) を指定します。 + このオプションを使用しても、cURL がより多くのデータを送信する可能性はあります。 + 実際に送信される内容は + CURLOPT_READFUNCTION に依存します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + cURL 7.1.0 以降で利用可能です。 @@ -1390,9 +1374,9 @@ - Set to a string with the name of the outgoing network interface to use. - This can be an interface name, an IP address or a host name. - Available as of cURL 7.1.0. + 使用する送信ネットワークインターフェースの名前を string で指定します。 + インターフェース名、IP アドレス、ホスト名のいずれかが指定できます。 + cURL 7.1.0 以降で利用可能です。 @@ -1403,13 +1387,11 @@ - 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. - Set to one of the - CURL_IPRESOLVE_* constants. - Defaults to CURL_IPRESOLVE_WHATEVER. - Available as of cURL 7.10.8. + ホスト名を解決する際に、使用する IP アドレスの種類をアプリケーションが選択できるようにします。 + これは、複数の IP バージョンを利用してアドレスを解決するようなホスト名を使う場合のみ意味があります。 + CURL_IPRESOLVE_* 定数のいずれかを設定してください。 + デフォルト値は CURL_IPRESOLVE_WHATEVER です。 + cURL 7.10.8 以降で利用可能です。 @@ -1420,14 +1402,12 @@ - If set to a string naming a file holding a CA certificate in PEM format, - an additional check against the peer certificate is performed - to verify the issuer is indeed the one associated - with the certificate provided by the option. - For the result of the check to be considered a failure, - this option should be used in combination with the - CURLOPT_SSL_VERIFYPEER option. - Available as of cURL 7.19.0. + PEM 形式の CA 証明書を保持するファイル名を string で指定します。 + このオプションが指定されると、ピア証明書に対する追加のチェックが実行され、 + 発行者が指定した証明書と実際に関連付けられているかどうかを確認します。 + チェックの結果を失敗と見なすには、 + このオプションを CURLOPT_SSL_VERIFYPEER オプションと組み合わせて使用する必要があります。 + cURL 7.19.0 以降で利用可能です。 @@ -1438,10 +1418,10 @@ - Pass a string with binary data of a CA SSL certificate in PEM format. - If set, an additional check against the peer certificate is performed - to verify the issuer is the one associated with the certificate provided by the option. - Available as of PHP 8.1.0 and cURL 7.71.0. + PEM 形式の CA SSL 証明書のバイナリデータが含まれた string を指定します。 + これが設定されていると、ピア証明書に対する追加のチェックが実行され、 + 発行者がこのオプションで提供された証明書に関連付けられたものであることを確認します。 + PHP 8.1.0 以降かつ cURL 7.71.0 以降で利用可能です。 @@ -1452,11 +1432,11 @@ - Set to &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. + &true; を指定すると、返された HTTP コードが 300 以上の場合にリクエストボディの送信を継続するようになります。 + デフォルトでは、送信を中止し、ストリームないし接続を閉じます。 + 手動 NTLM 認証に適しています。 + ほとんどのアプリケーションではこのオプションは必要ありません。 + PHP 7.3.0 以降かつ cURL 7.51.0 以降で利用可能です。 @@ -1467,10 +1447,10 @@ - Set to a string with the password required to use the CURLOPT_SSLKEY - or CURLOPT_SSH_PRIVATE_KEYFILE private key. - Setting this option to &null; disables using a password for these options. - Available as of cURL 7.17.0. + CURLOPT_SSLKEY または CURLOPT_SSH_PRIVATE_KEYFILE の秘密鍵を + 使用するにあたって必要なパスワードを string で指定します。 + &null; を設定すると、これらのオプションでパスワードが使えなくなります。 + cURL 7.17.0 以降で利用可能です。 @@ -1481,19 +1461,19 @@ - The KRB4 (Kerberos 4) security level. Any of the following string values - (in order from least to most powerful) are valid: + KRB4 (Kerberos 4) のセキュリティレベルを指定します。以下の string 値のいずれか + (最弱から最強の順) が有効です： 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. - Available as of cURL 7.3.0 and deprecated as of cURL 7.17.0. + + 指定した string がいずれにも一致しない場合、 + private が使われます。このオプションを &null; に設定すると + KRB4 セキュリティが無効になります。現在、KRB4 セキュリティは + FTP トランザクションでのみ動作します。 + cURL 7.3.0 以降で利用可能ですが、cURL 7.17.0 以降は非推奨となりました。 @@ -1504,19 +1484,19 @@ - Set the kerberos security level for FTP and also enables kerberos awareness. - This should be set to one of the following strings: + FTP の Kerberos セキュリティレベルを設定し、Kerberos に対応させます。 + 以下の string のいずれかを設定する必要があります： clear safe confidential private - . - If the string is set but does not match one of these, - private is used. - Setting this option to &null; will disable kerberos support for FTP. - Defaults to &null;. - Available as of cURL 7.16.4. + + 指定された string がいずれにも一致しない場合、 + private が使われます。 + このオプションを &null; に設定すると、FTP の Kerberos サポートが無効になります。 + デフォルト値は &null; です。 + cURL 7.16.4 以降で利用可能です。 @@ -1527,10 +1507,10 @@ - Sets the local port number of the socket used for the connection. - This option accepts any value that can be cast to a valid int. - Defaults to 0. - Available as of cURL 7.15.2. + 接続に用いるソケットのローカルポート番号を指定します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 0 です。 + cURL 7.15.2 以降で利用可能です。 @@ -1541,11 +1521,11 @@ - The number of attempts cURL makes to find a working local port number, - starting with the one set with CURLOPT_LOCALPORT. - This option accepts any value that can be cast to a valid int. - Defaults to 1. - Available as of cURL 7.15.2. + cURL が動作するローカルポート番号を探す試行回数を指定します。 + 検索は CURLOPT_LOCALPORT で設定されたポートから開始されます。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 1 です。 + cURL 7.15.2 以降で利用可能です。 @@ -1556,10 +1536,10 @@ - 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. + AUTH=NTLM や AUTH=* を介した優先認証メカニズムなど、 + プロトコル固有のログインオプションを設定します。 + CURLOPT_USERNAME オプションと併用すべきです。 + PHP 7.0.7 以降かつ cURL 7.34.0 以降で利用可能です。 @@ -1570,11 +1550,11 @@ - 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. - This option accepts any value that can be cast to a valid int. - Available as of cURL 7.1.0. + 転送速度がこの値を CURLOPT_LOW_SPEED_TIME 秒間下回っていた場合、 + PHP は転送を遅すぎるとみなして中止します。 + 単位はバイト/秒です。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + cURL 7.1.0 以降で利用可能です。 @@ -1585,11 +1565,10 @@ - The number of seconds the transfer speed should be below - CURLOPT_LOW_SPEED_LIMIT before PHP considers - the transfer too slow and aborts. - This option accepts any value that can be cast to a valid int. - Available as of cURL 7.1.0. + 転送速度が CURLOPT_LOW_SPEED_LIMIT の値をここで指定した秒数の間下回っていた場合、 + PHP は転送を遅すぎるとみなして中止します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + cURL 7.1.0 以降で利用可能です。 @@ -1600,13 +1579,10 @@ - Set a string with the authentication address (identity) - of a submitted message that is being relayed to another server. - The address should not be specified within a pair of angled brackets - (><). - If an empty string is used then a pair of brackets are sent by cURL - as required by RFC 2554. - Available as of cURL 7.25.0. + 別のサーバーにリレーされる送信メッセージの認証アドレス (アイデンティティ) を string で指定します。 + アドレスは山括弧 (><) で囲まずに指定してください。 + 空の string が使われた場合、RFC 2554 に従って山括弧の組が送信されます。 + cURL 7.25.0 以降で利用可能です。 @@ -1617,13 +1593,12 @@ - Set a string with the sender's email address when sending SMTP mail. - The email address should be specified with angled brackets - (><) around it, - which if not specified are added automatically. - If this parameter is not specified then an empty address is sent - to the SMTP server which might cause the email to be rejected. - Available as of cURL 7.20.0. + SMTP メール送信時の送信者のメールアドレスを string で指定します。 + このメールアドレスは、山括弧 (><) で囲んで指定する必要があり、 + 指定されていない場合は自動的に追加されます。 + このパラメーターが指定されていない場合、空のアドレスが + SMTP サーバーに送信され、メールが拒否される可能性があります。 + cURL 7.20.0 以降で利用可能です。 @@ -1634,14 +1609,13 @@ - Set to an array of strings - with the recipients to pass to the server in an SMTP mail request. - Each recipient should be specified within a pair of angled brackets - (><). - If an angled bracket is not used as the first character, - cURL assumes a single email address has been provided - and encloses that address within brackets. - Available as of cURL 7.20.0. + SMTP メールリクエストでサーバーに渡す受信者を、 + string の array で設定します。 + それぞれの受信者は、対になった山括弧 (><) で囲んで指定する必要があります。 + 最初の文字が山括弧でない場合、 + cURL は単一のメールアドレスが渡されたものと仮定し、 + そのアドレスを括弧で囲みます。 + cURL 7.20.0 以降で利用可能です。 @@ -1652,15 +1626,14 @@ - Set to 1 to allow RCPT TO command - to fail for some recipients which makes cURL ignore errors - for individual recipients and proceed with the remaining accepted recipients. - If all recipients trigger failures and this flag is specified, - cURL aborts the SMTP conversation - and returns the error received from to the last RCPT TO command. - Replaced by CURLOPT_MAIL_RCPT_ALLOWFAILS as of cURL 8.2.0. - Available as of PHP 8.2.0 and cURL 7.69.0. - Deprecated as of cURL 8.2.0. + 1 を指定すると、RCPT TO コマンドが一部の受信者で失敗しても + cURL はそのエラーを無視し、残りの成功した受信者に対して処理を継続します。 + すべての受信者でエラーになり、このフラグが指定されている場合、 + cURL は SMTP 通信を中止し + 最後の RCPT TO コマンドから受け取ったエラーを返します。 + cURL 8.2.0 で CURLOPT_MAIL_RCPT_ALLOWFAILS に置き換えられました。 + PHP 8.2.0 以降かつ cURL 7.69.0 以降で利用可能です。 + cURL 8.2.0 以降は非推奨となっています。 @@ -1671,10 +1644,10 @@ - The maximum idle time allowed for an existing connection to be considered for reuse. - Default maximum age is set to 118 seconds. - This option accepts any value that can be cast to a valid int. - Available as of PHP 8.2.0 and cURL 7.65.0. + 既存の接続が再利用される可能性のある最大アイドル時間を指定します。 + デフォルトの最大アイドル時間は 118 秒です。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + PHP 8.2.0 以降かつ cURL 7.65.0 以降で利用可能です。 @@ -1685,11 +1658,11 @@ - 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. - This option accepts any value that can be cast to a valid int. - Available as of cURL 7.7.0. + 永続化された接続の最大数を指定します。 + 制限に達すると、開いている接続の数が増えないよう、 + キャッシュ内の最も古いものが閉じられます。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + cURL 7.7.0 以降で利用可能です。 @@ -1700,22 +1673,20 @@ - Sets the maximum accepted size (in bytes) of a file to download. - If the file requested is found larger than this value, - the transfer is aborted - and CURLE_FILESIZE_EXCEEDED is returned. - Passing 0 disables this option, - and passing a negative size returns a - CURLE_BAD_FUNCTION_ARGUMENT. - If the file size is not known prior to the start of download, - this option has no effect. - For setting a size limit above 2GB, - CURLOPT_MAXFILESIZE_LARGE should be used. - As of cURL 8.4.0, this option also stops ongoing transfers - if they reach this threshold. - This option accepts any value that can be cast to a valid int. - Defaults to 0. - Available as of cURL 7.10.8. + ダウンロードするファイルの最大受入サイズ (バイト単位) を指定します。 + リクエストされたファイルがこの値よりも大きいことがわかると、 + 転送が中止され、CURLE_FILESIZE_EXCEEDED が返されます。 + 0 を渡すとこのオプションが無効になり、 + 負のサイズを渡すと CURLE_BAD_FUNCTION_ARGUMENT が返されます。 + ダウンロード開始前にファイルサイズがわからない場合、 + このオプションは効果がありません。 + 2GBを超えるサイズ制限を設定するには、 + CURLOPT_MAXFILESIZE_LARGE を使用する必要があります。 + cURL 8.4.0 以降では、転送中にこの閾値に達した場合にも + 進行中の転送を停止します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 0 です。 + cURL 7.10.8 以降で利用可能です。 @@ -1726,12 +1697,12 @@ - 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. - This option accepts any value that can be cast to a valid int. - Available as of PHP 8.2.0 and cURL 7.11.0. + ダウンロードが許可される最大ファイルサイズ (バイト単位) です。リクエストされたファイルがこの値よりも大きいことが判明した場合、 + 転送は開始されず、CURLE_FILESIZE_EXCEEDED が返されます。 + ファイルサイズが必ずしもダウンロード前にわかるとは限りません。そのようなファイルに対しては、 + ファイル転送が結果的にこの制限よりも大きくなったとしても、このオプションは効果がありません。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + PHP 8.2.0 以降かつ cURL 7.11.0 以降で利用可能です。 @@ -1742,12 +1713,11 @@ - 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. - This option accepts any value that can be cast to a valid int. - Available as of PHP 8.2.0 and cURL 7.80.0. + 既存の接続が再利用されうる最大時間を、接続が作成されてからの秒数で指定します。 + キャッシュ内にこの値よりも古い接続が見つかった場合、進行中の転送が完了するとその接続は再利用されずに閉じられます。 + デフォルトは 0 秒です。これは、このオプションが無効であり、すべての接続が再利用されうることを意味します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + PHP 8.2.0 以降かつ cURL 7.80.0 以降で利用可能です。 @@ -1758,10 +1728,10 @@ - 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. - Available as of cURL 7.5.0. + HTTP リダイレクトの最大回数を指定します。CURLOPT_FOLLOWLOCATION と合わせて使用してください。 + デフォルト値の 20 は、無限リダイレクトを防ぐために設定されています。 + -1 を指定すると何度でもリダイレクトするようになります。0 を指定すると一切リダイレクトしなくなります。 + cURL 7.5.0 以降で利用可能です。 @@ -1772,12 +1742,11 @@ - 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. - This option accepts any value that can be cast to a valid int. - Available as of cURL 7.15.5. + 転送中の累積平均でダウンロードがこの速度 (バイト毎秒単位) を超えた場合、 + 平均レートをこの値以下に保つために転送を一時停止します。 + デフォルトは無制限です。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + cURL 7.15.5 以降で利用可能です。 @@ -1788,12 +1757,11 @@ - 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. - This option accepts any value that can be cast to a valid int. - Available as of cURL 7.15.5. + 転送中の累積平均でアップロードがこの速度 (バイト毎秒単位) を超えた場合、 + 平均レートをこの値以下に保つために転送を一時停止します。 + デフォルトは無制限です。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + cURL 7.15.5 以降で利用可能です。 @@ -1804,10 +1772,10 @@ - Set to a bitmask of CURLMIMEOPT_* - constants. Currently there is only one available option: - CURLMIMEOPT_FORMESCAPE. - Available as of PHP 8.3.0 and cURL 7.81.0. + CURLMIMEOPT_* 定数のビットマスクを指定します。 + 現在利用可能なオプションは、 + CURLMIMEOPT_FORMESCAPE のみです。 + PHP 8.3.0 以降かつ cURL 7.81.0 以降で利用可能です。 @@ -1818,12 +1786,11 @@ - Set to &true; to be completely silent with regards to - the cURL functions. - Use CURLOPT_RETURNTRANSFER instead. - Available as of cURL 7.1.0, deprecated as of cURL 7.8.0 - and last available in cURL 7.15.5. - Removed as of PHP 7.3.0. + &true; を指定すると cURL 関数に関する出力が完全に抑制されます。 + このオプションの代わりに CURLOPT_RETURNTRANSFER を使用してください。 + cURL 7.1.0 以降で利用可能でしたが、cURL 7.8.0 からは非推奨となっており、 + cURL 7.15.5 を最後に削除されました。 + PHP 7.3.0 で削除されました。 @@ -1834,10 +1801,10 @@ - Set to &true; to scan the ~/.netrc - file to find a username and password for the remote site that - a connection is being established with. - Available as of cURL 7.1.0. + &true; を指定すると、 + 接続しているリモートサイトのユーザー名とパスワードを探すために + ~/.netrc ファイルをスキャンします。 + cURL 7.1.0 以降で利用可能です。 @@ -1848,11 +1815,11 @@ - Set a string containing the full path name to a .netrc file. - If this option is omitted and CURLOPT_NETRC is set, - cURL checks for a .netrc file - in the current user's home directory. - Available as of cURL 7.11.0. + .netrc ファイルへのフルパス名を含む string を指定します。 + このオプションが省略され、かつ CURLOPT_NETRC が設定されている場合、 + cURL は現在のユーザーのホームディレクトリにある + .netrc ファイルをチェックします。 + cURL 7.11.0 以降で利用可能です。 @@ -1863,12 +1830,11 @@ - Sets the value of the permissions (int) that is set on newly created directories - on the remote server. The default value is 0755. - The only protocols that can use this are - sftp://, scp:// - and file://. - Available as of cURL 7.16.4. + リモートサーバーで新しく作成されたディレクトリに設定されるパーミッションの値 (int) を設定します。 + デフォルト値は 0755 です。 + これを使用できるプロトコルは sftp://、scp://、 + file:// のみです。 + cURL 7.16.4 以降で利用可能です。 @@ -1879,12 +1845,12 @@ - Sets the value of the permissions (as an int) that are set on newly created files - on the remote server. The default value is 0644. - The only protocols that can use this are - sftp://, scp:// - and file://. - Available as of cURL 7.16.4. + リモートサーバーで新しく作成されたファイルに設定されるパーミッションの値 (int) を設定します。 + デフォルト値は 0644 です。 + これを使用できるプロトコルは + sftp://、scp://、 + file:// のみです。 + cURL 7.16.4 以降で利用可能です。 @@ -1895,11 +1861,11 @@ - Set to &true; to exclude the body from the output. - For HTTP(S), cURL makes a HEAD request. For most other protocols, - cURL is not asking for the body data at all. - Changing this to &false; will result in body data being included in the output. - Available as of cURL 7.1.0. + &true; を指定するとボディが出力から除外されます。 + HTTP(S) の場合、cURL は HEAD リクエストを実行します。他のほとんどのプロトコルの場合、 + cURL はボディデータを一切要求しません。 + これを &false; に変更すると、ボディデータが出力に含まれるようになります。 + cURL 7.1.0 以降で利用可能です。 @@ -1910,14 +1876,14 @@ - Set to &true; to disable the progress meter for cURL transfers. + &true; を指定すると cURL 転送でプログレスメーターを無効化します。 - PHP automatically sets this option to &true;, this should only be - changed for debugging purposes. + PHP はこのオプションを自動的に &true; に設定します。 + これを変えるのはデバッグ目的のみとしてください。 - Available as of cURL 7.1.0. + cURL 7.1.0 以降で利用可能です。 @@ -1928,17 +1894,15 @@ - Set a string consisting of a comma separated list of hostnames - that do not require a proxy to get reached. - Each name in this list is matched as either a domain - which contains the hostname or the hostname itself. - The only wildcard available in the string - is a single * character which matches all hosts, - effectively disabling the proxy. - Setting this option to an empty string enables the proxy for all hostnames. - Since cURL 7.86.0, IP addresses set with this option - can be provided using CIDR notation. - Available as of cURL 7.19.4. + 到達するのにプロキシを必要としないホスト名を、カンマ区切りのリストからなる string で設定します。 + このリスト内のそれぞれの名前は、ホスト名を含むドメインまたはホスト名自体として一致判定がなされます。 + この string で利用可能な唯一のワイルドカードは、 + すべてのホストにマッチする単一の * 文字です。 + これを指定すると実質的にプロキシが無効になります。 + このオプションに空の string を設定すると、すべてのホスト名でプロキシが有効になります。 + cURL 7.86.0 以降では、このオプションで設定する IP アドレスを + CIDR 記法で指定できます。 + cURL 7.19.4 以降で利用可能です。 @@ -1949,10 +1913,9 @@ - &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. + &true; を指定すると、PHP プロセスにシグナルを送信しうる cURL 関数を使わないようになります。 + マルチスレッド SAPI では、タイムアウトオプションを使えるようにするためにデフォルトで有効になっています。 + cURL 7.10 以降で利用可能です。 @@ -1963,7 +1926,7 @@ - A callable with the following signature: + 以下のシグニチャの callable を指定します。 stringcallback resourcecurlHandle @@ -1975,7 +1938,7 @@ curlHandle - The cURL handle. + cURL ハンドル。 @@ -1983,7 +1946,7 @@ passwordPrompt - A password prompt. + パスワードプロンプト。 @@ -1991,15 +1954,15 @@ maximumPasswordLength - The maximum length of the password. + パスワードの最大長。 - The callback should return a string containing the password. - Available as of cURL 7.4.2, deprecated as of cURL 7.11.1 - and last available in cURL 7.15.5. - Removed as of PHP 7.3.0. + このコールバックは、パスワードが入った string を返さなければなりません。 + cURL 7.4.2 以降で利用可能でしたが、cURL 7.11.1 からは非推奨となっており、 + cURL 7.15.5 を最後に削除されました。 + PHP 7.3.0 で削除されました。 @@ -2010,8 +1973,8 @@ - Set to a string with the password to use in authentication. - Available as of cURL 7.19.1. + 認証で使用するパスワードを string で指定します。 + cURL 7.19.1 以降で利用可能です。 @@ -2022,11 +1985,10 @@ - Set to &true; for cURL not alter URL paths before passing them on to the server. - Defaults to &false;, which squashes sequences of /../ - or /./ that may exist in the URL's path part - which is supposed to be removed according to RFC 3986 section 5.2.4. - Available as of PHP 7.0.7 and cURL 7.42.0. + &true; を指定すると、cURL が URL パスをサーバーに渡す前に書き換えないようになります。 + デフォルトは &false; で、URL のパス部分に含まれているかもしれない /../ や /./ の並びを圧縮します。 + これらは、RFC 3986 section 5.2.4 に従い削除されるべきと考えられます。 + PHP 7.0.7 以降かつ cURL 7.42.0 以降で利用可能です。 @@ -2037,12 +1999,11 @@ - Set a string with the pinned public key. - The string can be the file name of the pinned public key - in a PEM or DER file format. 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. + ピン留めされた (ピンニングされた) 公開鍵を string で指定します。 + この string には、PEM または DER 形式のピン留めされた公開鍵のファイル名を指定できます。 + また、先頭に sha256// を付けて ; で区切った + 任意の数の base64 エンコードされた sha256 ハッシュも指定できます。 + PHP 7.0.7 以降かつ cURL 7.39.0 以降で利用可能です。 @@ -2053,10 +2014,10 @@ - Set to &true; to wait for an existing connection to confirm - whether it can do multiplexing and use it if it can - before creating and using a new connection. - Available as of PHP 7.0.7 and cURL 7.43.0. + &true; を指定すると、新しい接続を作成して使用する前に、 + 既存の接続が多重化できるかどうかを確認し、 + 可能ならそうするよう待機します。 + PHP 7.0.7 以降かつ cURL 7.43.0 以降で利用可能です。 @@ -2067,9 +2028,9 @@ - An int with an alternative port number to connect to - instead of the one specified in the URL or the default port for the used protocol. - Available as of cURL 7.1.0. + URL で指定されたポートや使用するプロトコルのデフォルトポートの代わりに + 接続する代替ポート番号を int で指定します。 + cURL 7.1.0 以降で利用可能です。 @@ -2080,10 +2041,10 @@ - Set to &true; to do a HTTP POST request. - This request uses the application/x-www-form-urlencoded header. - Defaults to &false;. - Available as of cURL 7.1.0. + &true; を指定すると HTTP の POST リクエストを実行します。 + このリクエストは application/x-www-form-urlencoded ヘッダーを使用します。 + デフォルト値は &false; です。 + cURL 7.1.0 以降で利用可能です。 @@ -2094,16 +2055,16 @@ - The full data to post in a HTTP POST operation. - This parameter can either be - passed as a urlencoded string like 'para1=val1&para2=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. - Available as of cURL 7.1.0. + HTTP の POST 操作で送信する全データです。 + このパラメーターには、 + 'para1=val1&para2=val2&...' のような URL エンコードされた string か、 + フィールド名をキー、フィールドデータを値とする array のいずれかを渡すことができます。 + value が array の場合、 + Content-Type ヘッダーは + multipart/form-data に設定されます。 + ファイルは CURLFile または CURLStringFile を使って送信でき、 + その場合 value は array でなければなりません。 + cURL 7.1.0 以降で利用可能です。 @@ -2114,9 +2075,9 @@ - An array of FTP command strings - to execute on the server after the FTP request has been performed. - Available as of cURL 7.1.0. + FTP リクエストが実行された後にサーバーで実行する + FTP コマンドを string の array で指定します。 + cURL 7.1.0 以降で利用可能です。 @@ -2127,12 +2088,12 @@ - Set to a bitmask of CURL_REDIR_POST_301, - CURL_REDIR_POST_302 and CURL_REDIR_POST_303 - 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. + CURL_REDIR_POST_301、 + CURL_REDIR_POST_302、CURL_REDIR_POST_303 のビットマスクを指定します。 + CURLOPT_FOLLOWLOCATION が設定されており + かつ指定した種類のリダイレクトが発生した場合に、 + リダイレクト後のリクエストでも HTTP POST メソッドを使い続けるようになります。 + cURL 7.19.1 以降で利用可能です。 @@ -2143,19 +2104,17 @@ - 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. + プレプロキシとして使われるホスト名またはドット区切りの数値 IP アドレスを string で指定します。 + プレプロキシは、今後のリクエストにおいて CURLOPT_PROXY オプションで + 指定された HTTP(S) プロキシへ接続する前に cURL が接続するプロキシサーバーです。 + プレプロキシは SOCKS プロキシのみ可能で、使用する socks の種類を指定するために + [scheme]:// を頭に付けるべきです。 + 数値の IPv6 アドレスは、[角括弧] で囲む必要があります。 + プレプロキシを空の string に設定すると、プレプロキシの使用が明示的に無効になります。 + この string でポート番号を指定するには、ホスト名の最後に :[port] を付加します。 + プロキシのポート番号は、必要に応じて個別のオプション CURLOPT_PROXYPORT で指定できます。 + ポートが指定されていない場合、デフォルトではポート 1080 が使用されます。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2166,11 +2125,11 @@ - Set an array of FTP command strings to pass to the server - after the transfer type is set. - These commands are not performed when a directory listing is performed, - only for file transfers. - Available as of cURL 7.9.5. + 転送タイプが設定された後にサーバーへ渡す FTP コマンドを + string の array で指定します。 + これらのコマンドはディレクトリ列挙を行う際には実行されず、 + ファイル転送のみで実行されます。 + cURL 7.9.5 以降で利用可能です。 @@ -2181,13 +2140,13 @@ - 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. + この cURL ハンドルに関連付ける任意のデータを指定します。 + このデータは、後に curl_getinfo の + CURLINFO_PRIVATE オプションを使って取得できます。 + cURL はこのデータに対して何も行いません。 + cURL のマルチハンドルを使用する場合、このプライベートデータには通常 + 標準的な cURL ハンドルを識別するための一意なキーを指定します。 + cURL 7.10.3 以降で利用可能です。 @@ -2198,7 +2157,7 @@ - A callable with the following signature: + 以下のシグニチャの callable を指定します。 intcallback resourcecurlHandle @@ -2212,7 +2171,7 @@ curlHandle - The cURL handle. + cURL ハンドル。 @@ -2220,7 +2179,7 @@ bytesToDownload - The total number of bytes expected to be downloaded in this transfer. + この転送でダウンロードされようとしている総バイト数。 @@ -2228,7 +2187,7 @@ bytesDownloaded - The number of bytes downloaded so far. + これまでにダウンロードされたバイト数。 @@ -2236,7 +2195,7 @@ bytesToUpload - The total number of bytes expected to be uploaded in this transfer. + この転送でアップロードされようとしている総バイト数。 @@ -2244,21 +2203,21 @@ bytesUploaded - The number of bytes uploaded so far. + これまでにアップロードされたバイト数。 - The callback should return an int with a non-zero value to abort the transfer - and set a CURLE_ABORTED_BY_CALLBACK error. + 転送を中断し、CURLE_ABORTED_BY_CALLBACK エラーをセットするには、 + このコールバックから非ゼロの int を返してください。 - The callback is only called when the CURLOPT_NOPROGRESS - option is set to &false;. + このコールバックが呼ばれるのは、CURLOPT_NOPROGRESS オプションが + &false; に設定されている場合のみです。 - Available as of cURL 7.1.0 and deprecated as of cURL 7.32.0. - Use CURLOPT_XFERINFOFUNCTION instead. + cURL 7.1.0 以降で利用可能ですが、cURL 7.32.0 以降は非推奨となりました。 + 代わりに CURLOPT_XFERINFOFUNCTION を用いてください。 @@ -2269,11 +2228,11 @@ - Bitmask of CURLPROTO_* values. - If used, this bitmask limits what protocols cURL may use in the transfer. - Defaults to CURLPROTO_ALL, ie. cURL will accept all protocols it supports. - See also CURLOPT_REDIR_PROTOCOLS. - Available as of cURL 7.19.4 and deprecated as of cURL 7.85.0. + CURLPROTO_* 値のビットマスクを指定します。 + これが使われた場合、cURL が転送で使用できるプロトコルを制限します。 + デフォルトは CURLPROTO_ALL で、cURL はサポートするすべてのプロトコルを受け入れます。 + CURLOPT_REDIR_PROTOCOLS も参照してください。 + cURL 7.19.4 以降で利用可能ですが、cURL 7.85.0 以降は非推奨となりました。 @@ -2284,11 +2243,11 @@ - Set to a string with a comma separated list - of case insensitive protocol names (URL schemes) to allow in the transfer. - Set to ALL to enable all protocols. - By default, cURL accepts all protocols it was built with support for. - Available protocols are: + 転送で許可するプロトコル名 (URL スキーム) をカンマ区切りリストの string で指定します。 + 大文字小文字は区別しません。 + ALL を指定すると全てのプロトコルが許可されます。 + デフォルトでは、サポートする全プロトコルを受け入れます。 + 利用可能なプロトコルは以下のとおりです： DICT FILE @@ -2322,8 +2281,8 @@ TFTP WS WSS - . - Available as of PHP 8.3.0 and cURL 7.85.0. + + PHP 8.3.0 以降かつ cURL 7.85.0 以降で利用可能です。 @@ -2334,10 +2293,10 @@ - A string with the HTTP proxy to tunnel requests through. - This should be the hostname, the dotted numerical IP address - or a numerical IPv6 address written within [brackets]. - Available as of cURL 7.1.0. + リクエストをトンネリングする HTTP プロキシを string で指定します。 + ホスト名、ドット区切りの数値 IP アドレス、 + [角括弧] 内に書かれた数値 IPv6 アドレスのいずれかである必要があります。 + cURL 7.1.0 以降で利用可能です。 @@ -2348,13 +2307,12 @@ - A bitmask of the HTTP authentication method(s) - (CURLAUTH_* constants) - to use for the proxy connection. - For proxy authentication, only CURLAUTH_BASIC and - CURLAUTH_NTLM are currently supported. - Defaults to CURLAUTH_BASIC. - Available as of cURL 7.10.7. + プロキシ接続で使用する HTTP 認証方法を + CURLAUTH_* 定数のビットマスクで指定します。 + プロキシ認証では、現在 CURLAUTH_BASIC と + CURLAUTH_NTLM のみがサポートされています。 + デフォルト値は CURLAUTH_BASIC です。 + cURL 7.10.7 以降で利用可能です。 @@ -2365,8 +2323,8 @@ - An array of custom HTTP header strings to pass to proxies. - Available as of PHP 7.0.7 and cURL 7.37.0. + プロキシに渡すカスタム HTTP ヘッダーを string の array で指定します。 + PHP 7.0.7 以降かつ cURL 7.37.0 以降で利用可能です。 @@ -2377,8 +2335,8 @@ - Set a string with the password to be used for authentication with the proxy. - Available as of cURL 7.19.1. + プロキシでの認証に使用するパスワードを string で指定します。 + cURL 7.19.1 以降で利用可能です。 @@ -2389,11 +2347,11 @@ - An int with the port number of the proxy to connect to. - This port number can also be set in CURLOPT_PROXY. - Setting this to zero makes cURL use the default proxy port number - or the port number specified in the proxy URL string. - Available as of cURL 7.1.0. + 接続するプロキシのポート番号を int で指定します。 + このポート番号は CURLOPT_PROXY でも設定できます。 + これを 0 に設定すると、cURL はデフォルトのプロキシポート番号か + プロキシ URL string で指定されたポート番号を使用します。 + cURL 7.1.0 以降で利用可能です。 @@ -2404,10 +2362,9 @@ - Sets the type of the proxy to one of the - CURLPROXY_* constants. - Defaults to CURLPROXY_HTTP. - Available as of cURL 7.10. + プロキシの種類を CURLPROXY_* 定数のいずれかで指定します。 + デフォルト値は CURLPROXY_HTTP です。 + cURL 7.10 以降で利用可能です。 @@ -2418,8 +2375,8 @@ - Set a string with the username to be used for authentication with the proxy. - Available as of cURL 7.19.1. + プロキシでの認証に使用するユーザー名を string で指定します。 + cURL 7.19.1 以降で利用可能です。 @@ -2430,10 +2387,10 @@ - A string with a username and password formatted as - [username]:[password] to use for the - connection to the proxy. - Available as of cURL 7.1.0. + プロキシへの接続で使用するユーザー名とパスワードを、 + [ユーザー名]:[パスワード] の形式の + string で指定します。 + cURL 7.1.0 以降で利用可能です。 @@ -2444,13 +2401,12 @@ - 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 cURL's cacert bundle is assumed - to be stored. - Available as of PHP 7.3.0 and cURL 7.52.0. + プロキシ Certificate Authority (CA) バンドルへのパスを指定します。 + HTTPS プロキシを検証するための一つ以上の証明書を保持するファイルのパスを string で指定します。 + このオプションは HTTPS プロキシへの接続用であり、HTTPS サーバー用ではありません。 + デフォルトでは、cURL の cacert バンドルが格納されていると思われる + システムパスに設定されます。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2461,11 +2417,11 @@ - A string with 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 cURL's cacert bundle is assumed - to be stored. - Available as of PHP 8.2.0 and cURL 7.77.0. + HTTPS プロキシを検証するための一つ以上の証明書を保持する PEM ファイルの名前を string で指定します。 + このオプションは HTTPS プロキシへの接続用であり、HTTPS サーバー用ではありません。 + デフォルトでは、cURL の cacert バンドルが格納されていると思われる + システムパスに設定されます。 + PHP 8.2.0 以降かつ cURL 7.77.0 以降で利用可能です。 @@ -2476,9 +2432,8 @@ - A string with the directory holding multiple CA certificates - to verify the HTTPS proxy with. - Available as of PHP 7.3.0 and cURL 7.52.0. + HTTPS プロキシを検証するための CA 証明書が格納されたディレクトリを string で指定します。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2489,11 +2444,9 @@ - Set to a string with 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. + SSL 交換中の証明書検証で使用する PEM 形式の CRL (Certificate Revocation List; 証明書失効リスト) を + 記載したファイルの名前を string で指定します。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2504,8 +2457,8 @@ - Proxy issuer SSL certificate filename string. - Available as of PHP 8.1.0 and cURL 7.71.0. + プロキシ発行者の SSL 証明書ファイル名を string で指定します。 + PHP 8.1.0 以降かつ cURL 7.71.0 以降で利用可能です。 @@ -2516,8 +2469,8 @@ - A string with the proxy issuer SSL certificate. - Available as of PHP 8.1.0 and cURL 7.71.0. + プロキシ発行者の SSL 証明書を含む string を指定します。 + PHP 8.1.0 以降かつ cURL 7.71.0 以降で利用可能です。 @@ -2528,12 +2481,11 @@ - Set the string be used as the password required to use the - CURLOPT_PROXY_SSLKEY private key. - A passphrase is not needed to load a certificate - but one is needed to load a 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_SSLKEY の秘密鍵を使用するために必要なパスワードを string で指定します。 + 証明書を読み込むのにはパスフレーズは不要ですが、 + 秘密鍵を読み込むためには必要です。 + このオプションは HTTPS プロキシへの接続用です。HTTPS サーバーへの接続用ではありません。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2544,13 +2496,11 @@ - Set the pinned public key for HTTPS proxy. - The string can be the file name of the pinned public key - which is expected to be in a PEM - or DER file format. - 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. + HTTPS プロキシ用のピン留めされた (ピンニングされた) 公開鍵を指定します。 + この string には、PEM または DER 形式のピン留めされた公開鍵のファイル名を指定できます。 + また、先頭に sha256// を付けて ; で区切った + 任意の数の base64 エンコードされた sha256 ハッシュも指定できます。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2561,8 +2511,8 @@ - A string with 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). + プロキシ認証サービス名を string で指定します。 + PHP 7.0.7 以降かつ、HTTP プロキシを使う場合は cURL 7.43.0 以降、SOCKS5 プロキシを使う場合は cURL 7.49.0 以降で利用可能です。 @@ -2573,15 +2523,14 @@ - A string with the file name of the 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 - used for authentication as it is named in the security database. - If a file from the current directory is to be used, - it must be prefixed with ./ - in order to avoid confusion with a nickname. - Available as of PHP 7.3.0 and cURL 7.52.0. + HTTPS プロキシへの接続に用いるクライアント証明書のファイル名を string で指定します。 + Secure Transport でのデフォルト形式は P12、その他のエンジンでのデフォルト形式は PEM です。 + この形式は CURLOPT_PROXY_SSLCERTTYPE で変更できます。 + NSS または Secure Transport では、セキュリティデータベースで名前が付けられた + 証明書のニックネームも指定できます。 + カレントディレクトリのファイルを使う場合、 + ニックネームとの混同を避けるために ./ を頭に付ける必要があります。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2592,12 +2541,12 @@ - A string with the format of the 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. + HTTPS プロキシへの接続時に使用するクライアント証明書の形式を string で指定します。 + Secure Transport 以外では、サポートされている形式は PEM と DER です。 + OpenSSL (バージョン 0.9.3 以降) と Secure Transport + (iOS 5 以降または OS X 10.7 以降) では、PKCS#12 でエンコードされたファイル用の + P12 もサポートします。デフォルトは PEM です。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2608,8 +2557,8 @@ - A string with the SSL proxy client certificate. - Available as of PHP 8.1.0 and cURL 7.71.0. + SSL プロキシクライアント証明書を含む string を指定します。 + PHP 8.1.0 以降かつ cURL 7.71.0 以降で利用可能です。 @@ -2620,13 +2569,12 @@ - A string with the file name of the 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 with TLS enabled. - Available as of PHP 7.3.0 and cURL 7.52.0. + HTTPS プロキシへの接続に使用する秘密鍵のファイル名を string で指定します。 + デフォルトの形式は PEMで、 + CURLOPT_PROXY_SSLKEYTYPE を使って変更できます。 + (iOS および Mac OS X の場合) Secure Transport を使うように cURL をビルドした場合、このオプションは無視されます。 + TLS を有効にしてビルドした場合にのみ利用可能です。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2637,14 +2585,14 @@ - A string with the format of the private key. - Supported formats are: + 秘密鍵の形式を string で指定します。 + サポートされている形式は以下のとおりです： PEM DER ENG - . - Available as of PHP 7.3.0 and cURL 7.52.0. + 。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2655,8 +2603,8 @@ - A string with the private key for connecting to the HTTPS proxy. - Available as of PHP 8.1.0 and cURL 7.71.0. + HTTPS プロキシへ接続するための秘密鍵を含む string を指定します。 + PHP 8.1.0 以降かつ cURL 7.71.0 以降で利用可能です。 @@ -2667,18 +2615,17 @@ - Set the preferred HTTPS proxy TLS version to one of the - CURL_SSLVERSION_* - constants. - Defaults to CURL_SSLVERSION_DEFAULT. + 希望する HTTPS プロキシの TLS バージョンを + CURL_SSLVERSION_* 定数のいずれかで指定します。 + デフォルト値は CURL_SSLVERSION_DEFAULT です。 - 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. + このオプションは設定せずに、デフォルトをそのまま用いた方がよいでしょう。 + デフォルトの CURL_SSLVERSION_DEFAULT は、 + リモートの SSL プロトコルのバージョンを判別しようと試みます。 - Available as of PHP 7.3.0 and cURL 7.52.0. + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2689,12 +2636,10 @@ - A string with a colon-separated list of ciphers - to use for the connection to the HTTPS proxy. - When used with OpenSSL commas and spaces are also acceptable as separators, - and !, - and + - can be used as operators. - Available as of PHP 7.3.0 and cURL 7.52.0. + HTTPS プロキシへの接続に使用する暗号をコロン区切りの string で指定します。 + OpenSSL で使用する場合、カンマとスペースも区切り文字として使うことができ、 + !、-、+ を演算子として使用できます。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2705,9 +2650,9 @@ - Set proxy SSL behavior options, which is a bitmask of the - CURLSSLOPT_* constants. - Available as of PHP 7.3.0 and cURL 7.52.0. + プロキシの SSL 動作オプションを指定します。 + これは CURLSSLOPT_* 定数のビットマスクです。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2718,15 +2663,15 @@ - 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! - Set to 1 in cURL 7.28.0 and earlier as a debug option. - Set to 1 in cURL 7.28.1 to 7.65.3 CURLE_BAD_FUNCTION_ARGUMENT is returned. - As of cURL 7.66.0 1 and 2 is treated as the same value. - Defaults to 2. - In production environments the value of this option should be kept at 2. - Available as of PHP 7.3.0 and cURL 7.52.0. + 2 を指定すると、HTTPS プロキシの証明書名フィールドをプロキシ名と照合して検証します。 + 0 を指定すると、証明書で使用されている名前に関係なく接続が成功します。 + この機能は注意して使用してください！ + cURL 7.28.0 以前では、1 をデバッグオプションとして指定できます。 + cURL 7.28.1 から 7.65.3では、1 を指定すると CURLE_BAD_FUNCTION_ARGUMENT が返されます。 + cURL 7.66.0 以降では 1 は 2 と同じ値として扱われます。 + デフォルト値は 2 です。 + 本番環境では、このオプションの値は 2 のままにしておくべきです。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2737,14 +2682,12 @@ - Set to &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. + &false; を指定すると cURL が ピア証明書を検証しなくなります。 + 検証に使用する代替証明書は CURLOPT_CAINFO オプションで指定するか、 + 証明書ディレクトリを CURLOPT_CAPATH オプションで指定できます。 + &false; を指定すると、ピア証明書の検証は無条件で成功します。 + デフォルトは &true; です。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2755,11 +2698,11 @@ - A string with a colon-separated list of ciphers to use for the connection to the TLS 1.3 connection to a proxy. - This option is currently used only when cURL is built to use OpenSSL 1.1.1 or later. - When using a different SSL backend the TLS 1.3 cipher suites can be set - with the CURLOPT_PROXY_SSL_CIPHER_LIST option. - Available as of PHP 7.3.0 and cURL 7.61.0. + プロキシへの TLS 1.3 接続に使用する暗号をコロン区切りの string で指定します。 + このオプションは現在、cURL が OpenSSL 1.1.1 以降を使用してビルドされた場合にのみ使用されます。 + その他の SSL バックエンドを使用する場合、TLS 1.3 の暗号スイートは + CURLOPT_PROXY_SSL_CIPHER_LIST オプションで設定できます。 + PHP 7.3.0 以降かつ cURL 7.61.0 以降で利用可能です。 @@ -2770,10 +2713,10 @@ - A string with 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 オプションで指定された + TLS の認証方法で用いるパスワードを string で指定します。 + CURLOPT_PROXY_TLSAUTH_USERNAME オプションも合わせて設定する必要があります。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2784,17 +2727,17 @@ - The method of the TLS authentication used for the HTTPS connection. - Supported method is SRP. + HTTPS 接続で用いられる TLS の認証方法を string で指定します。 + サポートされている方法は SRP です。 - Secure Remote Password (SRP) authentication for TLS provides mutual authentication - if both sides have a shared secret. To use TLS-SRP, the - CURLOPT_PROXY_TLSAUTH_USERNAME and - CURLOPT_PROXY_TLSAUTH_PASSWORD options must also be set. + TLS の Secure Remote Password (SRP) 認証は、両者が共有シークレットを持っている場合に + 相互認証を提供します。TLS-SRP を使用するには、 + CURLOPT_PROXY_TLSAUTH_USERNAME オプションと + CURLOPT_PROXY_TLSAUTH_PASSWORD オプションも設定する必要があります。 - Available as of PHP 7.3.0 and cURL 7.52.0. + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2805,10 +2748,10 @@ - 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_PROXY_TLSAUTH_TYPEオプションで指定された + HTTPS プロキシの TLS 認証方法に使用するユーザー名を指定します。 + CURLOPT_PROXY_TLSAUTH_PASSWORD オプションも合わせて設定する必要があります。 + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 @@ -2819,14 +2762,13 @@ - Set to 1 to set the transfer mode (binary or ASCII) - for FTP transfers done via an HTTP proxy, by appending - type=a or type=i to the URL. - Without this setting or it being set to 0, - CURLOPT_TRANSFERTEXT has no effect - when doing FTP via a proxy. - Defaults to 0. - Available as of cURL 7.18.0. + 1 を指定すると、HTTP のプロキシを経由しておこなわれる FTP 転送の転送モード (バイナリないし ASCII) を設定するために + URL へ type=a または type=i を付加するようになります。 + この設定がなかったり 0 に設定されていたりする場合、 + プロキシ経由で FTP を実行するにあたって + CURLOPT_TRANSFERTEXT は無視されます。 + デフォルト値は 0 です。 + cURL 7.18.0 以降で利用可能です。 @@ -2837,10 +2779,9 @@ - &true; to HTTP PUT a file. The file to PUT must - be set with CURLOPT_READDATA and - CURLOPT_INFILESIZE. - Available as of cURL 7.1.0 and deprecated as of cURL 7.12.1. + &true; を指定すると HTTP PUT でファイルを送信します。PUT するファイルは + CURLOPT_READDATA と CURLOPT_INFILESIZE で設定しなければなりません。 + cURL 7.1.0 以降で利用可能ですが、cURL 7.12.1 以降は非推奨となりました。 @@ -2851,11 +2792,10 @@ - Set to &true; for cURL to skip cleanup of resources - when recovering from a timeout. - This allows for a swift termination of the cURL process - at the expense of a possible leak of associated resources. - Available as of PHP 8.3.0 and cURL 7.87.0. + &true; を指定すると、cURL がタイムアウトから復帰する際に、リソースの解放処理をスキップします。 + これにより、関連リソースがリークする可能性を犠牲に、 + cURL プロセスを迅速に終了できるようになります。 + PHP 8.3.0 以降かつ cURL 7.87.0 以降で利用可能です。 @@ -2866,8 +2806,8 @@ - An array of FTP command strings to execute on the server prior to the FTP request. - Available as of cURL 7.1.0. + FTP リクエストの前にサーバーで実行する FTP コマンドを string の array で指定します。 + cURL 7.1.0 以降で利用可能です。 @@ -2878,8 +2818,8 @@ - A string with a filename to be used to seed the random number generator for SSL. - Available as of cURL 7.7.0 and deprecated as of cURL 7.84.0. + SSL 用の乱数生成器のシードに用いるファイル名を string で指定します。 + cURL 7.7.0 以降で利用可能ですが、cURL 7.84.0 以降は非推奨となりました。 @@ -2890,11 +2830,10 @@ - A string with the 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. - Set to &null; to disable requesting a byte range. - Available as of cURL 7.1.0. + 取得するデータの範囲を X-Y 形式の string で指定します (X、Y の片方は省略できます)。 + HTTP 転送では、X-Y,N-M 形式でカンマ区切りの複数の範囲も指定できます。 + &null; を指定すると、バイト範囲のリクエストは無効になります。 + cURL 7.1.0 以降で利用可能です。 @@ -2905,9 +2844,9 @@ - Sets a file pointer resource that will be used by the file read function - set with CURLOPT_READFUNCTION. - Available as of cURL 7.9.7. + CURLOPT_READFUNCTION で設定されたファイル読み取り関数によって + 使用されるファイルポインタ resource を指定します。 + cURL 7.9.7 以降で利用可能です。 @@ -2918,7 +2857,7 @@ - A callable with the following signature: + 以下のシグニチャの callable を指定します。 stringcallback resourcecurlHandle @@ -2930,7 +2869,7 @@ curlHandle - The cURL handle. + cURL ハンドル。 @@ -2938,8 +2877,8 @@ streamResource - Stream resource provided to cURL through the option - CURLOPT_READDATA. + CURLOPT_READDATA オプションを通して + cURL へと渡されたストリーム resource。 @@ -2947,16 +2886,16 @@ maxAmountOfDataToRead - The maximum amount of data to be read. + 読み出すべきデータの最大長。 - The callback should 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. - Available as of cURL 7.1.0. + このコールバックは、要求されたデータ長以下の string を + 返さなければなりません。 + 典型的には、渡されたストリーム resource からデータを読み出して返します。 + EOF を伝えるためには空の string を返してください。 + cURL 7.1.0 以降で利用可能です。 @@ -2967,16 +2906,15 @@ - Bitmask of CURLPROTO_* values - which limit what protocols cURL may use in a transfer that it follows to in - a redirect when CURLOPT_FOLLOWLOCATION is enabled. - This allows limiting specific transfers to only be allowed to use a subset - of protocols in redirections. - As of cURL 7.19.4, by default cURL will allow all protocols - except for FILE and SCP. - Prior to cURL 7.19.4, cURL would unconditionally follow to all supported protocols. - See also CURLOPT_PROTOCOLS for protocol constant values. - Available as of cURL 7.19.4 and deprecated as of cURL 7.85.0. + CURLOPT_FOLLOWLOCATION が有効な場合に、 + リダイレクトで追跡する際の使用可能なプロトコルを + CURLPROTO_* 値のビットマスクで制限します。 + これにより、特定の転送でリダイレクト時にプロトコルのサブセットのみを使用するように制限できます。 + cURL 7.19.4 以降、cURL はデフォルトで FILE と SCP を除く + すべてのプロトコルで追跡を許可します。 + cURL 7.19.4 より前は、cURL はサポートされているすべてのプロトコルを無条件で追跡していました。 + プロトコルの定数については CURLOPT_PROTOCOLS も参照してください。 + cURL 7.19.4 以降で利用可能ですが、cURL 7.85.0 以降は非推奨となりました。 @@ -2987,19 +2925,18 @@ - Set to a string with a comma separated list - of case insensitive protocol names (URL schemes) - to allow to follow to in a redirect when - CURLOPT_FOLLOWLOCATION is enabled. - Set to ALL to enable all protocols. - As of cURL 7.65.2 it defaults to FTP, - FTPS, HTTP and HTTPS. - From cURL 7.40.0 to 7.65.1, this defaults to all protocols except - FILE, SCP, SMB and - SMBS. - Prior to cURL 7.40.0, this defaults to all protocols except - FILE and SCP. - Available protocols are: + CURLOPT_FOLLOWLOCATION が有効な場合に、リダイレクトでの追跡を許可する + プロトコル名 (URL スキーム) をカンマ区切りリストの string で指定します。 + プロトコル名の大文字小文字は区別しません。 + ALL を指定するとすべてのプロトコルで追跡を有効にします。 + cURL 7.65.2 以降、デフォルトは FTP、 + FTPS、HTTP、HTTPS です。 + cURL 7.40.0 から 7.65.1 では、 + FILE、SCP、SMB、 + SMBS を除くすべてのプロトコルがデフォルトでした。 + cURL 7.40.0 より前は、FILE と SCP を除く + すべてのプロトコルがデフォルトでした。 + 利用可能なプロトコルは以下のとおりです： DICT FILE @@ -3033,8 +2970,8 @@ TFTP WS WSS - . - Available as of PHP 8.3.0 and cURL 7.85.0. + + PHP 8.3.0 以降かつ cURL 7.85.0 以降で利用可能です。 @@ -3045,9 +2982,9 @@ - A string with the contents of the Referer: - header to be used in a HTTP request. - Available as of cURL 7.1.0. + HTTP リクエストで使用する Referer: ヘッダーの内容を + string で指定します。 + cURL 7.1.0 以降で利用可能です。 @@ -3058,9 +2995,9 @@ - A string to use in the upcoming request - instead of the path as extracted from the URL. - Available as of PHP 7.3.0 and cURL 7.55.0. + URL から抽出されたパスに代わって + 今後のリクエストで使用するパスを string で指定します。 + PHP 7.3.0 以降かつ cURL 7.55.0 以降で利用可能です。 @@ -3071,15 +3008,16 @@ - Provide an array of colon-separated strings - with custom addresses for specific host and port pairs in the following format: + 特定のホスト・ポートの組み合わせに対するカスタムアドレスを、 + コロン区切りの string の array で指定します。 + 具体的な形式は以下のとおりです： array( "example.com:80:127.0.0.1", "example2.com:443:127.0.0.2", ) - Available as of cURL 7.21.3. + cURL 7.21.3 以降で利用可能です。 @@ -3090,9 +3028,9 @@ - The offset, in bytes, to resume a transfer from. - This option accepts any value that can be cast to a valid int. - Available as of cURL 7.1.0. + 転送を再開するバイト単位のオフセットを指定します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + cURL 7.1.0 以降で利用可能です。 @@ -3103,9 +3041,8 @@ - &true; to return the transfer as a string of the - return value of curl_exec instead of outputting - it directly. + &true; を指定すると、転送の出力を直接出力する代わりに、 + curl_exec の戻り値として string の形で返します。 @@ -3116,11 +3053,11 @@ - Set an int with the CSEQ number to issue for the next RTSP request. - Useful if the application is resuming a previously broken connection. - The CSEQ increments from this new number henceforth. - Defaults to 0. - Available as of cURL 7.20.0. + 次の RTSP リクエストに対して発行する CSEQ 番号を int で指定します。 + アプリケーションが断絶された接続を再開するときに有用です。 + 以後 CSEQ はこの新しい番号からインクリメントされます。 + デフォルト値は 0 です。 + cURL 7.20.0 以降で利用可能です。 @@ -3131,10 +3068,9 @@ - Sets the kind of RTSP request to make. - Must be one of the CURL_RTSPREQ_* - constants. - Available as of cURL 7.20.0. + 作成する RTSP リクエストの種類を指定します。 + CURL_RTSPREQ_* 定数のいずれかを使う必要があります。 + cURL 7.20.0 以降で利用可能です。 @@ -3145,11 +3081,10 @@ - Set an int with the CSEQ number to expect - for the next RTSP Server to Client request. - This feature (listening for Server requests) is unimplemented. - Defaults to 0. - Available as of cURL 7.20.0. + 次のサーバーからクライアントへの RTSP リクエストで期待する CSEQ 番号を int で指定します。 + この機能 (サーバーリクエストの待ち受け) は未実装です。 + デフォルト値は 0 です。 + cURL 7.20.0 以降で利用可能です。 @@ -3160,14 +3095,14 @@ - Set a string with the value of the current RTSP Session ID for the handle. - Once this value is set to any non-&null; value, - cURL returns CURLE_RTSP_SESSION_ERROR - if the ID received from the server does not match. - If set to &null;, cURL automatically sets the ID - the first time the server sets it in a response. - Defaults to &null; - Available as of cURL 7.20.0. + このハンドルの現在の RTSP セッション ID の値を string で指定します。 + この値が何らかの非 &null; 値に設定されると、 + サーバーから受信した ID が一致しない場合 + cURL は CURLE_RTSP_SESSION_ERROR を返します。 + &null; に設定されている場合、サーバーが最初にレスポンス内で ID を設定したときに + cURL が自動的に ID を設定します。 + デフォルトは &null; です。 + cURL 7.20.0 以降で利用可能です。 @@ -3178,14 +3113,13 @@ - Sets a string with the stream URI to operate on. - If not set, cURL defaults to operating on generic server options - by passing * in the place of the RTSP Stream URI. - When working with RTSP, CURLOPT_RTSP_STREAM_URI - indicates what URL to send to the server in the request header - while the CURLOPT_URL indicates - where to make the connection to. - Available as of cURL 7.20.0. + 操作するストリーム URI を string で指定します。 + 設定されていない場合、cURL は RTSP ストリーム URI の代わりに * を渡し、 + 一般的なサーバーオプションで動作します。 + RTSP の場合、CURLOPT_RTSP_STREAM_URI は + リクエストヘッダーでサーバーへ送信する URL を表し、 + CURLOPT_URL は接続先を示します。 + cURL 7.20.0 以降で利用可能です。 @@ -3196,8 +3130,8 @@ - Set the Transport: header for this RTSP session. - Available as of cURL 7.20.0. + この RTSP セッションの Transport: ヘッダーを指定します。 + cURL 7.20.0 以降で利用可能です。 @@ -3208,11 +3142,11 @@ - 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. + 常に &true; です (訳注: &true; 以外の値を設定しようとするとエラーになります)。 + cURL では CURLOPT_POSTFIELDS で @ から始まる値を渡すことで + ファイルをアップロードできますが、これを無効にします。 + これにより、@ で始まる値をフィールドとして安全に渡すことができます。 + ファイルのアップロードには CURLFile が代わりに使用できます。 @@ -3223,11 +3157,11 @@ - The authorization identity (authzid) string 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. + 転送で用いる認可 ID (authzid) を string で指定します。 + これは PLAIN SASL 認証メカニズムのみに適用され、指定は任意です。 + 指定されていない場合、ユーザー名で指定された認証 ID (authcid) のみがパスワードとともにサーバーに送信されます。 + authzid が与えられていない場合、サーバーは authcid から authzid を導出し、それを内部的に使用します。 + PHP 8.2.0 以降かつ cURL 7.66.0 以降で利用可能です。 @@ -3238,8 +3172,8 @@ - &true; to enable sending the initial response in the first packet. - Available as of PHP 7.0.7 and cURL 7.31.0. + &true; を指定すると、最初のパケットで初期レスポンスの送信が有効になります。 + PHP 7.0.7 以降かつ cURL 7.31.0 以降で利用可能です。 @@ -3250,8 +3184,8 @@ - A string with the authentication service name. - Available as of PHP 7.0.7 and cURL 7.43.0. + 認証サービス名を string で指定します。 + PHP 7.0.7 以降かつ cURL 7.43.0 以降で利用可能です。 @@ -3262,9 +3196,9 @@ - A result of curl_share_init. Makes the cURL - handle to use the data from the shared handle. - Available as of cURL 7.10. + curl_share_init の返り値を渡します。 + この cURL ハンドルが、指定した共有ハンドルのデータを使用するようにします。 + cURL 7.10 以降で利用可能です。 @@ -3275,17 +3209,17 @@ - The SOCKS5 authentication method(s) to use. The options are: + 使用する SOCKS5 の認証方法を指定します。選択肢は以下のとおりです： CURLAUTH_BASIC CURLAUTH_GSSAPI CURLAUTH_NONE - . - When more than one method is set, cURL will poll the server to see - what methods it supports and pick the best one. - 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. + + 複数のメソッドが設定されている場合、cURL はサーバーをポーリングして + サポートされるメソッドを確認し、最適なものを選択します。 + デフォルト値は CURLAUTH_BASIC|CURLAUTH_GSSAPI です。 + 実際のユーザー名とパスワードは CURLOPT_PROXYUSERPWD オプションで設定します。 + PHP 7.3.0 以降かつ cURL 7.55.0 以降で利用可能です。 @@ -3296,10 +3230,10 @@ - Set to 1 to enable and 0 to disable - the unprotected exchange of the protection mode negotiation - as part of the GSSAPI negotiation. - Available as of cURL 7.19.4. + 1 を指定すると + GSSAPI ネゴシエーションの一部としての保護モードネゴシエーションの非保護交換を有効にします。 + 0 を指定すると無効にします。 + cURL 7.19.4 以降で利用可能です。 @@ -3310,10 +3244,10 @@ - Set a string holding the name of the SOCKS5 service. - Defaults to rcmd. - Available as of cURL 7.19.4 and deprecated as of cURL 7.49.0. - Use CURLOPT_PROXY_SERVICE_NAME instead. + SOCKS5 サービスの名前を string で指定します。 + デフォルト値は rcmd です。 + cURL 7.19.4 以降で利用可能ですが、cURL 7.49.0 以降は非推奨となりました。 + 代わりに CURLOPT_PROXY_SERVICE_NAME を使用してください。 @@ -3324,7 +3258,7 @@ - A bitmask consisting of one or more of the following constants: + 以下の定数の 1 つ以上から構成されるビットマスクを指定します： CURLSSH_AUTH_PUBLICKEY CURLSSH_AUTH_PASSWORD @@ -3332,9 +3266,9 @@ CURLSSH_AUTH_KEYBOARD CURLSSH_AUTH_AGENT CURLSSH_AUTH_ANY - . - Defaults to CURLSSH_AUTH_ANY. - Available as of cURL 7.16.1. + + デフォルト値は CURLSSH_AUTH_ANY です。 + cURL 7.16.1 以降で利用可能です。 @@ -3345,10 +3279,10 @@ - &true; to enable, &false; to disable built-in SSH compression. - Note that the server can disregard this request. - Defaults to &false;. - Available as of PHP 7.3.0 and cURL 7.56.0. + &true; を指定すると内蔵の SSH 圧縮が有効になり、&false; を指定すると無効になります。 + サーバーがこのリクエストを無視する可能性があることに注意してください。 + デフォルト値は &false; です。 + PHP 7.3.0 以降かつ cURL 7.56.0 以降で利用可能です。 @@ -3359,8 +3293,8 @@ - A callable that will be called when SSH host key verification is needed. - The callback must have the following signature: + SSH ホストキーの検証が必要になった場合に呼ばれる callable を指定します。 + このコールバックは、以下のシグニチャである必要があります。 intcallback resourcecurlHandle @@ -3373,7 +3307,7 @@ curlHandle - The cURL handle. + cURL ハンドル。 @@ -3381,7 +3315,7 @@ keyType - One of the CURLKHTYPE_* key types. + CURLKHTYPE_* のうちいずれかのキーの種類。 @@ -3389,7 +3323,7 @@ key - The key to check. + チェックするキー。 @@ -3397,13 +3331,13 @@ keyLength - The length of the key in bytes. + キーのバイト長。 - This callback overrides CURLOPT_SSH_KNOWNHOSTS. - Available as of PHP 8.3.0 and cURL 7.84.0. + このコールバックは CURLOPT_SSH_KNOWNHOSTS を上書きします。 + PHP 8.3.0 以降かつ cURL 7.84.0 以降で利用可能です。 @@ -3414,11 +3348,10 @@ - A string containing 32 hexadecimal digits which should contain the - MD5 checksum of the remote host's public key, and cURL 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. + リモートホストの公開鍵の MD5 チェックサムを、32 桁の十六進数の string で指定します。 + md5sum が一致しない限り、cURL はホストへの接続を拒否します。 + このオプションは SCP 転送と SFTP 転送のみに対応しています。 + cURL 7.17.1 以降で利用可能です。 @@ -3429,10 +3362,9 @@ - A string with the 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. + リモートホストの公開鍵の SHA256 ハッシュを、base64 エンコードされた string で指定します。 + 与えられたハッシュがリモートホストから提供されるハッシュと一致しない場合、転送は失敗します。 + PHP 8.2.0 以降かつ cURL 7.80.0 以降で利用可能です。 @@ -3443,9 +3375,9 @@ - Set to the filename of the known_host file to use - which should use the OpenSSH file format as supported by libssh2. - Available as of cURL 7.19.6. + 使用する known_host ファイルの名前を指定します。 + このファイルには、libssh2 でサポートされている OpenSSH ファイル形式を用いてください。 + cURL 7.19.6 以降で利用可能です。 @@ -3456,12 +3388,12 @@ - The file name for a private key. If not used, cURL 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. + 秘密鍵のファイル名を指定します。このオプションが指定されない場合、 + 環境変数 HOME が設定されていれば $HOME/.ssh/id_dsa を、 + 設定されていなければカレントディレクトリの id_dsa をデフォルトとします。 + ファイルがパスワードで保護されている場合、 + CURLOPT_KEYPASSWD でパスワードを指定します。 + cURL 7.16.1 以降で利用可能です。 @@ -3472,10 +3404,10 @@ - The file name for a public key. If not used, cURL 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. + 公開鍵のファイル名を指定します。このオプションが指定されない場合、 + 環境変数 HOME が設定されていれば $HOME/.ssh/id_dsa.pub を、 + 設定されていなければカレントディレクトリの id_dsa.pub をデフォルトとします。 + cURL 7.16.1 以降で利用可能です。 @@ -3486,8 +3418,8 @@ - The name of a file containing a PEM formatted certificate. - Available as of cURL 7.1.0. + PEM 形式の証明書を含むファイル名を指定します。 + cURL 7.1.0 以降で利用可能です。 @@ -3498,9 +3430,8 @@ - The password required to use the - CURLOPT_SSLCERT certificate. - Available as of cURL 7.1.0 and deprecated as of cURL 7.17.0. + CURLOPT_SSLCERT の証明書を使用するために必要なパスワードを指定します。 + cURL 7.1.0 以降で利用可能ですが、cURL 7.17.0 以降は非推奨となりました。 @@ -3511,16 +3442,16 @@ - A string with the format of the certificate. Supported formats are: + 証明書のフォーマットを string で指定します。サポートされているフォーマット： PEM DER ENG P12 - . - P12 (for PKCS#12-encoded files) is available as of OpenSSL 0.9.3. - Defaults to PEM. - Available as of cURL 7.9.3. + + P12 (PKCS#12 でエンコードされたファイル用) は OpenSSL 0.9.3 以降で利用可能です。 + デフォルト値は PEM です。 + cURL 7.9.3 以降で利用可能です。 @@ -3531,8 +3462,8 @@ - A string with the SSL client certificate. - Available as of PHP 8.1.0 and cURL 7.71.0. + SSL のクライアント証明書を string で指定します。 + PHP 8.1.0 以降かつ cURL 7.71.0 以降で利用可能です。 @@ -3543,9 +3474,8 @@ - The string identifier for the crypto engine of the private SSL key - specified in CURLOPT_SSLKEY. - Available as of cURL 7.9.3. + CURLOPT_SSLKEY で指定された SSL 秘密鍵で用いる暗号化エンジンの識別子を string で指定します。 + cURL 7.9.3 以降で利用可能です。 @@ -3556,9 +3486,8 @@ - The string identifier for the crypto engine used for asymmetric crypto - operations. - Available as of cURL 7.9.3. + 非対称暗号化操作に用いられる暗号化エンジンの識別子を string で指定します。 + cURL 7.9.3 以降で利用可能です。 @@ -3569,8 +3498,8 @@ - The name of a file containing a private SSL key. - Available as of cURL 7.9.3. + SSL 秘密鍵を含むファイル名を指定します。 + cURL 7.9.3 以降で利用可能です。 @@ -3581,15 +3510,15 @@ - The secret password needed to use the private SSL key specified in - CURLOPT_SSLKEY. + CURLOPT_SSLKEY + で指定された SSL 秘密鍵を使用するために必要な秘密パスワードを設定します。 - Since this option contains a sensitive password, remember to keep - the PHP script it is contained within safe. + このオプションには機密パスワードが含まれているため、 + これを含む PHP スクリプトを必ず安全に保つようにしてください。 - Available as of cURL 7.9.3 and deprecated as of cURL 7.17.0. + cURL 7.9.3 以降で利用可能ですが、cURL 7.17.0 以降は非推奨となりました。 @@ -3600,15 +3529,15 @@ - The key type of the private SSL key specified in - CURLOPT_SSLKEY. Supported key types are: + CURLOPT_SSLKEY で指定された SSL の秘密鍵の種類を設定します。 + サポートされている鍵の種類は以下のとおりです： PEM DER ENG - . - Defaults to PEM. - Available as of cURL 7.9.3. + + デフォルト値は PEM です。 + cURL 7.9.3 以降で利用可能です。 @@ -3619,8 +3548,8 @@ - A string private key for client cert. - Available as of PHP 8.1.0 and cURL 7.71.0. + クライアント証明書用の秘密鍵を string で指定します。 + PHP 8.1.0 以降かつ cURL 7.71.0 以降で利用可能です。 @@ -3631,21 +3560,18 @@ - One of - the CURL_SSLVERSION_* constants. + CURL_SSLVERSION_* + 定数のいずれかを指定します。 - It is better to not set this option and leave the defaults. - As setting this to - CURL_SSLVERSION_SSLv2 - or - CURL_SSLVERSION_SSLv3 - is very dangerous, given the known - vulnerabilities in SSLv2 and SSLv3. + このオプションは設定せずに、デフォルトをそのまま用いた方がよいでしょう。 + これを CURL_SSLVERSION_SSLv2 や + CURL_SSLVERSION_SSLv3 に設定するのは、 + SSLv2 や SSLv3 の既知の脆弱性を考えれば極めて危険です。 - Defaults to CURL_SSLVERSION_DEFAULT. - Available as of cURL 7.1.0. + デフォルト値は CURL_SSLVERSION_DEFAULT です。 + cURL 7.1.0 以降で利用可能です。 @@ -3656,9 +3582,8 @@ - A colon-separated string of ciphers to use - for the TLS 1.2 (1.1, 1.0) connection. - Available as of cURL 7.9. + TLS 1.2 (1.1、1.0) の接続に用いる暗号をコロン区切りの string で指定します。 + cURL 7.9 以降で利用可能です。 @@ -3669,11 +3594,11 @@ - 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. + 楕円曲線アルゴリズムをコロン区切りリストで指定します。例えば、 + X25519:P-521 は 2 つの楕円曲線を指定している有効なリストです。 + このオプションは、cURL をビルドする際に指定した SSL バックエンドがそのアルゴリズムをサポートしていれば、 + SSL ハンドシェイクにおけるクライアントの鍵交換アルゴリズムを定義します。 + PHP 8.2.0 以降かつ cURL 7.73.0 以降で利用可能です。 @@ -3684,10 +3609,10 @@ - &false; to disable ALPN in the SSL handshake (if the SSL backend - cURL 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. + &false; を指定すると SSL ハンドシェイクで ALPN を無効にします + (cURL をビルドする際に指定した SSL バックエンドがそれをサポートしている場合)。 + ALPN は http2 のネゴシエーションに使われるものです。 + PHP 7.0.7 以降かつ cURL 7.36.0 以降で利用可能です。 @@ -3698,10 +3623,10 @@ - &false; to disable NPN in the SSL handshake (if the SSL backend - cURL 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, and deprecated as of cURL 7.86.0. + &false; を指定すると SSL ハンドシェイクで NPN を無効にします + (cURL をビルドする際に指定した SSL バックエンドがそれをサポートしている場合)。 + NPN は http2 のネゴシエーションに使われるものです。 + PHP 7.0.7 以降かつ cURL 7.36.0 以降で利用可能ですが、cURL 7.86.0 以降は非推奨となりました。 @@ -3712,10 +3637,10 @@ - &true; to enable and &false; to disable TLS false start - which is a mode where a TLS client starts sending application data - before verifying the server's Finished message. - Available as of PHP 7.0.7 and cURL 7.42.0. + &true; を指定すると TLS の False Start が有効になり、&false; を指定すると無効になります。 + False Start モードは、TLS クライアントがサーバーの Finished メッセージを検証する前に + アプリケーションデータの送信を開始するモードです。 + PHP 7.0.7 以降かつ cURL 7.42.0 以降で利用可能です。 @@ -3726,10 +3651,10 @@ - Set SSL behavior options, which is a bitmask of the - CURLSSLOPT_* constants. - Defaults to none of the bits being set. - Available as of PHP 7.0.7. and cURL 7.25.0. + SSL の動作オプションを + CURLSSLOPT_* 定数のビットマスクで指定します。 + デフォルトではどのビットも設定されていません。 + PHP 7.0.7. 以降かつ cURL 7.25.0 以降で利用可能です。 @@ -3740,10 +3665,10 @@ - Set to 0 to disable and 1 to enable - SSL session-ID caching. - By default all transfers are done using the cache enabled. - Available as of cURL 7.16.0. + 0 を指定すると SSL のセッション ID キャッシュが無効になり、 + 1 を指定すると有効になります。 + デフォルトでは、キャッシュを有効にした状態ですべての転送が実行されます。 + cURL 7.16.0 以降で利用可能です。 @@ -3754,13 +3679,14 @@ - 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. - Available as of cURL 7.8.1. + 2 を指定すると、SSL のピア証明書の Common Name フィールドまたは Subject Alternate Name フィールドが + 与えられたホスト名と一致するかどうかを検証します。 + 0 を指定すると、名前をチェックしません。 + 1 は使用すべきではありません。 + 本番環境では、このオプションの値は + 2 (デフォルト値) のままにしておくべきです。 + 値 1 のサポートは cURL 7.28.1 で削除されました。 + cURL 7.8.1 以降で利用可能です。 @@ -3771,14 +3697,12 @@ - &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. - Defaults to &true; as of cURL 7.10. - Default bundle of CA certificates installed as of cURL 7.10. - Available as of cURL 7.4.2. + &false; を指定すると cURL が ピア証明書を検証しなくなります。 + 検証に使用する代替証明書は CURLOPT_CAINFO オプションで指定するか、 + 証明書ディレクトリを CURLOPT_CAPATH オプションで指定できます。 + cURL 7.10 以降のデフォルト値は &true; です。 + cURL 7.10 以降は、デフォルトの CA 証明書バンドルがインストールされています。 + cURL 7.4.2 以降で利用可能です。 @@ -3789,8 +3713,8 @@ - &true; to enable and &false; to disable verification of the certificate's status. - Available as of PHP 7.0.7 and cURL 7.41.0. + &true; を指定すると、証明書のステータスの検証が有効になります。&false; を指定すると無効になります。 + PHP 7.0.7 以降かつ cURL 7.41.0 以降で利用可能です。 @@ -3801,10 +3725,9 @@ - Accepts a file handle resource pointing to - an alternative location to output errors to instead of - STDERR. - Available as of cURL 7.1.0. + STDERR の代わりにエラーを出力する代替場所を + 指すファイルハンドルを resource で指定します。 + cURL 7.1.0 以降で利用可能です。 @@ -3815,8 +3738,8 @@ - Set the numerical stream weight (a number between 1 and 256). - Available as of PHP 7.0.7 and cURL 7.46.0. + ストリームの重み (1 から 256 の間の数値) を数値で設定します。 + PHP 7.0.7 以降かつ cURL 7.46.0 以降で利用可能です。 @@ -3827,11 +3750,11 @@ - &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. - Defaults to &false;. - Available as of PHP 7.3.0 and cURL 7.54.0. + &true; を指定すると、CURLOPT_HTTPPROXYTUNNEL が使われて CONNECT リクエストが生成された場合に、 + ユーザーコールバック関数 CURLOPT_HEADERFUNCTION および CURLOPT_WRITEFUNCTION へ + プロキシ CONNECT レスポンスヘッダを渡さなくなります。 + デフォルト値は &false; です。 + PHP 7.3.0 以降かつ cURL 7.54.0 以降で利用可能です。 @@ -3842,8 +3765,8 @@ - &true; to enable and &false; to disable TCP Fast Open. - Available as of PHP 7.0.7 and cURL 7.49.0. + &true; を指定すると TCP Fast Open を有効にし、&false; を指定すると無効にします。 + PHP 7.0.7 以降かつ cURL 7.49.0 以降で利用可能です。 @@ -3854,13 +3777,12 @@ - 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. - The maximum number of probes can be set with the CURLOPT_TCP_KEEPCNT - option. - Available as of cURL 7.25.0. + 1 を指定すると TCP のキープアライブプローブが送信されます。 + 送られるプローブの遅延と頻度は、オペレーティングシステムがサポートしていれば + CURLOPT_TCP_KEEPIDLE オプションと CURLOPT_TCP_KEEPINTVL オプションで制御できます。 + 0 (デフォルト) を指定すると キープアライブプローブが無効になります。 + プローブの最大数は CURLOPT_TCP_KEEPCNT オプションで設定できます。 + cURL 7.25.0 以降で利用可能です。 @@ -3871,11 +3793,11 @@ - 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_KEEPALIVE が有効でなければ効果はありません。 + なお、すべてのオペレーティングシステムがこのオプションをサポートしているわけではありません。 + デフォルトは 60 です。 + cURL 7.25.0 以降で利用可能です。 @@ -3886,11 +3808,11 @@ - 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_KEEPALIVE が有効でなければ効果はありません。 + なお、すべてのオペレーティングシステムがこのオプションをサポートしているわけではありません。 + デフォルトは 60 です。 + cURL 7.25.0 以降で利用可能です。 @@ -3901,9 +3823,9 @@ - Sets the maximum number of TCP keep-alive probes. - The default is 9. - Available as of PHP 8.4.0 and cURL 8.9.0. + TCP におけるキープアライブプローブの最大送信数を指定します。 + デフォルトは 9 です。 + PHP 8.4.0 以降かつ cURL 8.9.0 以降で利用可能です。 @@ -3914,10 +3836,10 @@ - &true; to disable TCP's Nagle algorithm, which tries to minimize - the number of small packets on the network. - Defaults to &true;. - Available as of cURL 7.11.2. + &true; を指定すると、TCP の Nagle アルゴリズム + (ネットワーク上の小さなパケットの数を最小化しようとするアルゴリズム) を無効にします。 + デフォルト値は &true; です。 + cURL 7.11.2 以降で利用可能です。 @@ -3928,11 +3850,11 @@ - Set an array of strings to pass to the telnet negotiations. - The variables should be in the format >option=value<. - cURL supports the options TTYPE, - XDISPLOC and NEW_ENV. - Available as of cURL 7.7.0. + telnet ネゴシエーションに渡す string の array を指定します。 + 変数は >option=value< 形式である必要があります。 + cURLは、TTYPE、 + XDISPLOC、NEW_ENV をサポートしています。 + cURL 7.7.0 以降で利用可能です。 @@ -3943,14 +3865,14 @@ - Set the blocksize to use for TFTP data transmission. - Valid range is 8-65464 bytes. - The default of 512 bytes is used if this option is not specified. - The specified block size is only used if supported by the remote server. - If the server does not return an option acknowledgment - or returns an option acknowledgment with no block size, - the default of 512 bytes is used. - Available as of cURL 7.19.4. + TFTP データ転送に使用するブロックサイズを指定します。 + 有効な値の範囲は 8 から 65464 バイトです。 + このオプションが指定されていない場合、デフォルトの 512 バイトが使用されます。 + 指定されたブロックサイズは、リモートサーバーがサポートしている場合に限り使用されます。 + サーバーがオプション確認を返さない場合や、 + ブロックサイズなしでオプション確認を返してきた場合、 + デフォルトの 512 バイトが使われます。 + cURL 7.19.4 以降で利用可能です。 @@ -3961,9 +3883,9 @@ - &true; to not send TFTP options requests. - Defaults to &false;. - Available as of PHP 7.0.7 and cURL 7.48.0. + &true; を指定すると、TFTP でオプションリクエストを送信しないようになります。 + デフォルト値は &false; です。 + PHP 7.0.7 以降かつ cURL 7.48.0 以降で利用可能です。 @@ -3974,19 +3896,19 @@ - Set 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. - Prior to cURL 7.46.0 the default was - CURL_TIMECOND_IFMODSINCE. - Available as of cURL 7.1.0. + CURLOPT_TIMEVALUE の扱い方を設定します。 + CURL_TIMECOND_IFMODSINCE を指定すると、 + CURLOPT_TIMEVALUE で指定された時刻以降にページが変更された場合に限り + そのページを返します。ページが変更されていない場合、 + 304 Not Modified ヘッダーが返されます + (レスポンスのヘッダー部を確認するには CURLOPT_HEADER を &true; に設定しておく必要があります)。 + CURL_TIMECOND_IFUNMODSINCE を使うとその逆の動作になります。 + CURLOPT_TIMEVALUE を無視して常にページを返すには + CURL_TIMECOND_NONE を使用します。 + デフォルトは CURL_TIMECOND_NONE です。 + cURL 7.46.0 以前のデフォルトは + CURL_TIMECOND_IFMODSINCE でした。 + cURL 7.1.0 以降で利用可能です。 @@ -3997,9 +3919,9 @@ - The maximum number of seconds to allow cURL functions to execute. - Defaults to 0, meaning that functions never time out during transfer. - Available as of cURL 7.1.0. + cURL 関数の実行を許容する最大秒数を指定します。 + デフォルトは 0 で、転送中に関数がタイムアウトしないことを意味します。 + cURL 7.1.0 以降で利用可能です。 @@ -4010,13 +3932,12 @@ - The maximum number of milliseconds to allow cURL functions to - execute. - If cURL 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. - Defaults to 0, meaning that functions never time out during transfer. - Available as of cURL 7.16.2. + cURL 関数の実行を許容する最大ミリ秒数を指定します。 + cURL がシステム標準の名前解決器を使うようにビルドされている場合、 + 接続のその部分のタイムアウトは秒精度となり、 + 指定できる最小のタイムアウトも 1 秒になります。 + デフォルトは 0 で、転送中に関数がタイムアウトしないことを意味します。 + cURL 7.16.2 以降で利用可能です。 @@ -4027,10 +3948,10 @@ - The time in seconds since January 1st, 1970. The time will be used - by CURLOPT_TIMECONDITION. - Defaults to 0. - Available as of cURL 7.1.0. + 1970 年 1 月 1 日からの秒数で表した時刻を指定します。この時刻は + CURLOPT_TIMECONDITION で使われます。 + デフォルト値は 0 です。 + cURL 7.1.0 以降で利用可能です。 @@ -4041,12 +3962,12 @@ - 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. + 1970 年 1 月 1 日からの秒数で表した時刻を指定します。この時刻は + CURLOPT_TIMECONDITION で使われます。デフォルトは 0 です。 + このオプションと CURLOPT_TIMEVALUE の違いは引数の型です。 + 'long' が 32 ビット幅しかないシステムでは、 + 2038 年を超える日付を設定するのにこちらのオプションを使う必要があります。 + PHP 7.3.0 以降かつ cURL 7.59.0 以降で利用可能です。 @@ -4057,12 +3978,11 @@ - A string with a colon-separated list of ciphers - to use for the connection to the TLS 1.3 connection. - This option is currently used only when cURL is built to use OpenSSL 1.1.1 or later. - When using a different SSL backend the TLS 1.3 cipher suites can be set - with the CURLOPT_SSL_CIPHER_LIST option. - Available as of PHP 7.3.0 and cURL 7.61.0. + TLS 1.3 接続で用いる暗号を、コロン区切りの string で指定します。 + このオプションは現在、cURL が OpenSSL 1.1.1 以降を使用してビルドされた場合にのみ使用されます。 + その他の SSL バックエンドを使用する場合、TLS 1.3 の暗号スイートは + CURLOPT_SSL_CIPHER_LIST オプションで設定できます。 + PHP 7.3.0 以降かつ cURL 7.61.0 以降で利用可能です。 @@ -4073,11 +3993,12 @@ - Set a password to use for the TLS authentication method specified - with the CURLOPT_TLSAUTH_TYPE option. Requires that - the CURLOPT_TLSAUTH_USERNAME option also be set. - This feature relies on TLS SRP which does not work with TLS 1.3. - Available as of cURL 7.21.4. + CURLOPT_TLSAUTH_TYPE オプションで指定された + TLS の認証方法で用いるパスワードを string で指定します。 + CURLOPT_TLSAUTH_USERNAME オプションも + 合わせて設定する必要があります。 + この機能は TLS SRP に依存しており、TLS 1.3 では動作しません。 + cURL 7.21.4 以降で利用可能です。 @@ -4088,10 +4009,9 @@ - Set a string with the method of the TLS authentication. - Supported method is SRP - (TLS Secure Remote Password authentication). - Available as of cURL 7.21.4. + TLS の認証方法を string で指定します。 + サポートされているのは SRP (TLS Secure Remote Password 認証) です。 + cURL 7.21.4 以降で利用可能です。 @@ -4102,12 +4022,12 @@ - Set a string with the username to use for the TLS authentication method - specified with the CURLOPT_TLSAUTH_TYPE option. - Requires that the CURLOPT_TLSAUTH_PASSWORD option - also be set. - This feature relies on TLS SRP which does not work with TLS 1.3. - Available as of cURL 7.21.4. + CURLOPT_TLSAUTH_TYPE オプションで指定された + TLS の認証方法で用いるユーザー名を string で指定します。 + CURLOPT_TLSAUTH_PASSWORD オプションも + 合わせて設定する必要があります。 + この機能は TLS SRP に依存しており、TLS 1.3 では動作しません。 + cURL 7.21.4 以降で利用可能です。 @@ -4118,13 +4038,13 @@ - Set to 1 to enable and 0 to disable - requesting compressed Transfer Encoding in the outgoing - HTTP request. If the server responds with a compressed - Transfer Encoding, - cURL will automatically uncompress it on reception. - Defaults to 0. - Available as of cURL 7.21.6. + 1 を指定すると、送信される HTTP リクエストで圧縮形式の Transfer Encoding を + 要求するようになります。 + 0 を指定すると無効になります。 + サーバーが圧縮形式の Transfer Encoding で応答したなら、 + cURL は受信時に自動で展開します。 + デフォルト値は 0 です。 + cURL 7.21.6 以降で利用可能です。 @@ -4135,12 +4055,11 @@ - &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. - Defaults to &false;. - Available as of cURL 7.1.1. + &true; を指定すると FTP 転送で ASCII モードを使用します。 + LDAP では、HTML の代わりにプレーンテキストでデータを取得します。 + Windows システムでは、STDOUT をバイナリモードに設定しないようになります。 + デフォルト値は &false; です。 + cURL 7.1.1 以降で利用可能です。 @@ -4151,11 +4070,11 @@ - Enables the use of Unix domain sockets as connection endpoint and - sets the path to the given string. - Set to &null; to disable. - Defaults to &null;. - Available as of PHP 7.0.7 and cURL 7.40.0. + 接続エンドポイントとして Unix ドメインソケットの使用を有効にし、 + 指定された string をそのパスとして設定します。 + &null; を設定すると無効になります。 + デフォルト値は &null; です。 + PHP 7.0.7 以降かつ cURL 7.40.0 以降で利用可能です。 @@ -4166,12 +4085,10 @@ - &true; to keep sending the username and password - when following locations (using - CURLOPT_FOLLOWLOCATION), even when the - hostname has changed. - Defaults to &false;. - Available as of cURL 7.10.4. + &true; を指定すると、(CURLOPT_FOLLOWLOCATION を使って) ロケーションを追跡する際に、 + ホスト名が変更されたとしてもユーザー名とパスワードを送り続けます。 + デフォルト値は &false; です。 + cURL 7.10.4 以降で利用可能です。 @@ -4182,13 +4099,13 @@ - 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. - Defaults to CURL_UPKEEP_INTERVAL_DEFAULT - which is currently 60 seconds. - Available as of PHP 8.2.0 and cURL 7.62.0. + 一部のプロトコルには「接続保持」メカニズムがあります。これらのメカニズムは通常、 + 接続を保持するために既存の接続へ何らかのトラフィックを送信します。このオプションは接続保持間隔を設定します。 + 現在、接続保持メカニズムを持つ唯一のプロトコルは HTTP/2 です。 + 接続保持間隔を超えると、既存の接続へ HTTP/2 PING フレームが送信されます。 + デフォルトは CURL_UPKEEP_INTERVAL_DEFAULT で、 + 現在は 60 秒です。 + PHP 8.2.0 以降かつ cURL 7.62.0 以降で利用可能です。 @@ -4199,9 +4116,9 @@ - &true; to prepare for and perform an upload. - Defaults to &false;. - Available as of cURL 7.1.0. + &true; を指定するとアップロードの準備と実行を行います。 + デフォルト値は &false; です。 + cURL 7.1.0 以降で利用可能です。 @@ -4212,10 +4129,10 @@ - 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. + cURL のアップロードバッファのサイズをバイト単位で指定します。 + バッファサイズのデフォルトは 64 キロバイトです。設定可能な最大バッファサイズは 2 メガバイトです。 + 設定可能な最小バッファサイズは 16 キロバイトです。 + PHP 8.2.0 以降かつ cURL 7.62.0 以降で利用可能です。 @@ -4226,9 +4143,9 @@ - The URL to fetch. This can also be set when initializing a - session with curl_init. - Available as of cURL 7.1.0. + 取得する URL を指定します。この設定は curl_init で + セッションを初期化する際にも指定できます。 + cURL 7.1.0 以降で利用可能です。 @@ -4239,13 +4156,12 @@ - Sets the desired level of SSL/TLS for the transfer - when using FTP, SMTP, POP3, IMAP, etc. - These are all protocols that start out plain text - and get "upgraded" to SSL using the STARTTLS command. - Set to one of the - CURLUSESSL_* constants. - Available as of cURL 7.17.0. + FTP、SMTP、POP3、IMAP などを使用する際の + 転送における SSL/TLS の要求レベルを設定します。 + これらのプロトコルはすべて平文で開始し、 + STARTTLS コマンドを使用して SSL に「アップグレード」されます。 + CURLUSESSL_* 定数のいずれかを設定します。 + cURL 7.17.0 以降で利用可能です。 @@ -4256,9 +4172,8 @@ - The contents of the User-Agent: header to be - used in a HTTP request. - Available as of cURL 7.1.0. + HTTP リクエストで使われる User-Agent: ヘッダーの内容を指定します。 + cURL 7.1.0 以降で利用可能です。 @@ -4269,8 +4184,8 @@ - The user name to use in authentication. - Available as of cURL 7.19.1. + 認証に用いるユーザー名を指定します。 + cURL 7.19.1 以降で利用可能です。 @@ -4281,10 +4196,9 @@ - A username and password formatted as - [username]:[password] to use for the - connection. - Available as cURL 7.1.0. + [username]:[password] の形で + 接続に用いるユーザー名とパスワードを指定します。 + cURL 7.1.0 以降で利用可能です。 @@ -4295,11 +4209,11 @@ - &true; to output verbose information. Writes - output to STDERR, or the file specified using - CURLOPT_STDERR. - Defaults to &false;. - Available as of cURL 7.1.0. + &true; を指定すると、詳細な情報を出力します。 + 出力は STDERR か、 + CURLOPT_STDERR で指定されたファイルへと書き込まれます。 + デフォルト値は &false; です。 + cURL 7.1.0 以降で利用可能です。 @@ -4310,13 +4224,11 @@ - Set to 1 to transfer multiple files - according to a filename pattern. - The pattern can be specified as part of the - CURLOPT_URL option, - using an fnmatch-like pattern (Shell Pattern Matching) - in the last part of URL (filename). - Available as of cURL 7.21.0. + 1 を指定すると、ファイル名パターンによって複数のファイルを転送します。 + パターンは CURLOPT_URL オプションの一部として指定でき、 + URL の最後の部分 (ファイル名) で + fnmatch 風のパターン (シェルパターンマッチング) を使用します。 + cURL 7.21.0 以降で利用可能です。 @@ -4327,7 +4239,7 @@ - A callable with the following signature: + 以下のシグニチャの callable を指定します。 intcallback resourcecurlHandle @@ -4338,7 +4250,7 @@ curlHandle - The cURL handle. + cURL ハンドル。 @@ -4346,15 +4258,14 @@ data - The data to be written. + 書き込むべきデータ。 - The data must be saved by the callback - and the callback must return the exact number of bytes written - or the transfer will be aborted with an error. - Available as of cURL 7.1.0. + このコールバックは、データを保存して書き込んだバイト数を返さなければなりません。 + そうしないなら、転送はエラーで中止されます (訳注: 一度にすべてのデータを書き込む必要があり、部分的な書き込みはできません。つまり、返り値は渡されたデータ長と一致しなければなりません)。 + cURL 7.1.0 以降で利用可能です。 @@ -4365,8 +4276,8 @@ - Accepts a file handle resource to the file that the header part of the transfer is written to. - Available as of cURL 7.1.0. + 転送のヘッダー部が書き込まれるファイルへのファイルハンドルを resource で指定します。 + cURL 7.1.0 以降で利用可能です。 @@ -4377,10 +4288,10 @@ - Accepts a bitmask setting WebSocket behavior options. - The only available option is CURLWS_RAW_MODE. - Defaults to 0. - Available as of PHP 8.3.0 and cURL 7.86.0. + WebSocket の動作オプションを設定するビットマスクを指定します。 + 利用可能な唯一の選択肢は CURLWS_RAW_MODE です。 + デフォルト値は 0 です。 + PHP 8.3.0 以降かつ cURL 7.86.0 以降で利用可能です。 @@ -4391,7 +4302,7 @@ - A callable with the following signature: + 以下のシグニチャの callable を指定します。 intcallback resourcecurlHandle @@ -4405,7 +4316,7 @@ curlHandle - The cURL handle. + cURL ハンドル。 @@ -4413,7 +4324,7 @@ bytesToDownload - The total number of bytes expected to be downloaded in this transfer. + この転送でダウンロードされようとしている総バイト数。 @@ -4421,7 +4332,7 @@ bytesDownloaded - The number of bytes downloaded so far. + これまでにダウンロードされたバイト数。 @@ -4429,7 +4340,7 @@ bytesToUpload - The total number of bytes expected to be uploaded in this transfer. + この転送でアップロードされようとしている総バイト数。 @@ -4437,14 +4348,14 @@ bytesUploaded - The number of bytes uploaded so far. + これまでにアップロードされたバイト数。 - Return 1 to abort the transfer - and set a CURLE_ABORTED_BY_CALLBACK error. - Available as of PHP 8.2.0 and cURL 7.32.0. + 転送を中断し、CURLE_ABORTED_BY_CALLBACK エラーをセットするには、 + 1 を返してください。 + PHP 8.2.0 以降かつ cURL 7.32.0 以降で利用可能です。 @@ -4455,12 +4366,12 @@ - A timeout in seconds cURL will wait for a response from an - FTP, SFTP, IMAP, - SCP, SMTP, or a POP3 server. - This option replaces the existing CURLOPT_FTP_RESPONSE_TIMEOUT - option which is deprecated in cURL 7.85.0. - Available as of PHP 8.4.0. + サーバーからのレスポンスを cURL が待機するタイムアウト秒数を指定します。この設定が使われるのは、 + FTP サーバー、SFTP サーバー、IMAP サーバー、 + SCP サーバー、SMTP サーバー、POP3 サーバーです。 + このオプションは、cURL 7.85.0 で非推奨となった + CURLOPT_FTP_RESPONSE_TIMEOUT を置き換えます。 + PHP 8.4.0 以降で利用可能です。 @@ -4471,10 +4382,10 @@ - Specifies the OAuth 2.0 access token. - Set to &null; to disable. - Defaults to &null;. - Available as of PHP 7.0.7 and cURL 7.33.0. + OAuth 2.0 のアクセストークンを指定します。 + &null; を指定すると無効化されます。 + デフォルト値は &null; です。 + PHP 7.0.7 以降かつ cURL 7.33.0 以降で利用可能です。 @@ -4485,11 +4396,11 @@ - A callable with the following signature that gets called after the - connection is established, but before the request payload (for example, the - GET/POST/DELETE request of an HTTP connection) is sent, and can be used to abort - or allow the connection depending on the source and destination IP address and - port numbers: + 以下のシグニチャを持つ callable を指定します。 + このコールバックは、接続が確立され、リクエストペイロード + (例えば、HTTP 接続における GET/POST/DELETE リクエスト) が送られる前に呼ばれます。 + 送信元/送信先 IP アドレスやポート番号に応じて接続を中止したり許可したりするのに + 用いることができます。 intcallback CurlHandlecurlHandle @@ -4503,7 +4414,7 @@ curlHandle - The cURL handle. + cURL ハンドル。 @@ -4511,9 +4422,9 @@ destination_ip - The primary IP of the remote server established with this connection. - For FTP, this is the IP for the control connection. - IPv6 addresses are represented without surrounding brackets. + この接続で確立されたリモートサーバーのプライマリー IP アドレス。 + FTP の場合は、制御用接続の IP アドレスになります。 + IPv6 のアドレスは、角括弧で囲わずに表現されます。 @@ -4521,8 +4432,8 @@ local_ip - The originating IP for this connection. - IPv6 addresses are represented without surrounding brackets. + この接続の送信元 IP アドレス。 + IPv6 のアドレスは、角括弧で囲わずに表現されます。 @@ -4530,9 +4441,9 @@ destination_port - The primary port number on the remote server established with this connection. - For FTP, this is the port for the control connection. - This can be a TCP or a UDP port number depending on the protocol. + この接続で確立されたリモートサーバーのプライマリーポート番号。 + FTP の場合は、制御用接続のポート番号になります。 + プロトコルに応じて、TCP または UDP のポート番号になります。 @@ -4540,15 +4451,15 @@ local_port - The originating port number for this connection. - This can be a TCP or a UDP port number depending on the protocol. + この接続の送信元ポート番号。 + プロトコルに応じて、TCP または UDP のポート番号になります。 - Return CURL_PREREQFUNC_OK to allow the request, or - CURL_PREREQFUNC_ABORT to abort the transfer. - Available as of PHP 8.4.0 and cURL 7.80.0. + リクエストを許可する場合は CURL_PREREQFUNC_OK を、 + 転送を中止する場合は CURL_PREREQFUNC_ABORT を返してください。 + PHP 8.4.0 以降かつ cURL 7.80.0 以降で利用可能です。 @@ -4559,11 +4470,11 @@ - Available as of PHP 8.4.0. - This option requires CURLOPT_VERBOSE option enabled. - A callable to replace the standard cURL verbose output. - This callback gets called during various stages of the request with verbose debug information. - The callback should match the following signature: + PHP 8.4.0 以降で利用可能です。 + このオプションを利用するには CURLOPT_VERBOSE オプションを有効にする必要があります。 + cURL 標準の詳細出力を置き換える callable を指定します。 + このコールバックは、リクエストのさまざまな段階で詳細なデバッグ情報とともに呼び出されます。 + これは以下のシグニチャである必要があります。 voidcallback CurlHandlecurlHandle @@ -4575,7 +4486,7 @@ curlHandle - The cURL handle. + cURL ハンドル。 @@ -4583,7 +4494,7 @@ type - One of the following constants indicating the type of the data value: + data の値の種類を表す以下の定数のいずれか： @@ -4593,7 +4504,7 @@ - Informational text. + なんらかの情報を表すテキスト。 @@ -4604,7 +4515,7 @@ - Header (or header-like) data received from the peer. + 相手から受信したヘッダー (あるいはヘッダーのような) データ。 @@ -4615,7 +4526,7 @@ - Header (or header-like) data sent to the peer. + 相手に送信したヘッダー (あるいはヘッダーのような) データ。 @@ -4626,8 +4537,8 @@ - Unprocessed protocol data received from the peer. - Even if the data is encoded or compressed, it is not provided decoded nor decompressed to this callback. + 相手から受信した未処理のプロトコルデータ。 + データがエンコードされていたり圧縮されていたりしたとしても、デコードされたデータや展開されたデータがコールバックへ渡されることはありません。 @@ -4638,7 +4549,7 @@ - Protocol data sent to the peer. + 相手に送信したプロトコルデータ。 @@ -4649,7 +4560,7 @@ - SSL/TLS (binary) data received from the peer. + 相手から受信した SSL/TLS の (バイナリ) データ。 @@ -4660,7 +4571,7 @@ - SSL/TLS (binary) data sent to the peer. + 相手に送信した SSL/TLS の (バイナリ) データ。 @@ -4671,7 +4582,7 @@ data - Verbose debug data of the type indicate by the type parameter. + type パラメーターで示された種類の詳細なデバッグデータ。 From c9d9531948b83fea16ce50303199af62c83e5b87 Mon Sep 17 00:00:00 2001 From: nsfisis Date: Mon, 13 Oct 2025 21:04:11 +0900 Subject: [PATCH 3/6] =?UTF-8?q?DNS=20=E6=96=87=E8=84=88=E3=81=AB=E3=81=8A?= =?UTF-8?q?=E3=81=91=E3=82=8B=20"resolver"=20=E3=81=AE=E5=AE=9A=E8=A8=B3?= =?UTF-8?q?=E3=82=92=E3=80=8C=E3=83=AA=E3=82=BE=E3=83=AB=E3=83=90=E3=80=8D?= =?UTF-8?q?=E3=81=AB=E7=B5=B1=E4=B8=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- reference/curl/constants_curl_setopt.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/reference/curl/constants_curl_setopt.xml b/reference/curl/constants_curl_setopt.xml index 45b89bbf7c..fc428ae95f 100644 --- a/reference/curl/constants_curl_setopt.xml +++ b/reference/curl/constants_curl_setopt.xml @@ -258,7 +258,7 @@ 接続するまでの最大待機ミリ秒数を指定します。 0 を指定するといつまでも待機します。 - cURL がシステム標準の名前解決器を使うようにビルドされている場合、 + cURL がシステム標準のネームリゾルバを使うようにビルドされている場合、 接続のその部分のタイムアウトは秒精度となり、 指定できる最小の待機時間も 1 秒になります。 このオプションは、有効な int にキャストできる任意の値を受け付けます。 @@ -519,7 +519,7 @@ - DNS 解決器がバインドされているネットワークインターフェース名を指定します。 + DNS リゾルバがバインドされているネットワークインターフェース名を指定します。 アドレスではなくインターフェース名を指定する必要があります。 このオプションは string ないし &null; を受け取ります。 PHP 7.0.7 以降かつ cURL 7.33.0 以降で利用可能です。 @@ -533,7 +533,7 @@ - 名前解決器がバインドされているローカル IPv4 アドレスを指定します。 + リゾルバがバインドされているローカル IPv4 アドレスを指定します。 この引数は単一の数値 IPv4 アドレスを含んでいる必要があります。 このオプションは string ないし &null; を受け取ります。 PHP 7.0.7 以降かつ cURL 7.33.0 以降で利用可能です。 @@ -547,7 +547,7 @@ - 名前解決器がバインドされているローカル IPv5 アドレスを指定します。 + リゾルバがバインドされているローカル IPv5 アドレスを指定します。 この引数は単一の数値 IPv6 アドレスを含んでいる必要があります。 このオプションは string ないし &null; を受け取ります。 PHP 7.0.7 以降かつ cURL 7.33.0 以降で利用可能です。 @@ -3933,7 +3933,7 @@ cURL 関数の実行を許容する最大ミリ秒数を指定します。 - cURL がシステム標準の名前解決器を使うようにビルドされている場合、 + cURL がシステム標準のネームリゾルバを使うようにビルドされている場合、 接続のその部分のタイムアウトは秒精度となり、 指定できる最小のタイムアウトも 1 秒になります。 デフォルトは 0 で、転送中に関数がタイムアウトしないことを意味します。 From 315b8c3fa2b8a8a0c457c76129ebd4eee7171a66 Mon Sep 17 00:00:00 2001 From: nsfisis Date: Mon, 13 Oct 2025 21:07:39 +0900 Subject: [PATCH 4/6] =?UTF-8?q?=E3=80=8C=E3=81=8A=E3=81=93=E3=81=AA?= =?UTF-8?q?=E3=81=86=E3=80=8D=E3=80=8C=E8=A1=8C=E3=81=86=E3=80=8D=E3=81=AE?= =?UTF-8?q?=E8=A1=A8=E8=A8=98=E3=82=86=E3=82=8C=E3=82=92=E7=B5=B1=E4=B8=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- reference/curl/constants_curl_setopt.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/reference/curl/constants_curl_setopt.xml b/reference/curl/constants_curl_setopt.xml index fc428ae95f..5d31fee8b7 100644 --- a/reference/curl/constants_curl_setopt.xml +++ b/reference/curl/constants_curl_setopt.xml @@ -274,8 +274,8 @@ - &true; を指定すると、必要なプロキシの認証をおこなって接続を確立するだけで、 - データ転送をおこなわなくなります。このオプションは + &true; を指定すると、必要なプロキシの認証を行って接続を確立するだけで、 + データ転送を行わなくなります。このオプションは HTTP、SMTP、POP3 で実装されています。 デフォルト値は &false; です。 cURL 7.15.2 以降で利用可能です。 @@ -319,7 +319,7 @@ クッキーデータを格納したファイル名を string で指定します。 クッキーファイルは Netscape 形式か、通常の HTTP スタイルのヘッダーをそのままファイルにダンプしたものです。 ファイル名が空の string の場合、クッキーは読み込まれませんが、クッキーの処理は - おこなわれます。 + 行われます。 cURL 7.1.0 以降で利用可能です。 @@ -332,7 +332,7 @@ cURL が保持しているすべてのクッキーを保存するファイル名を string で指定します。 - 書込は cURL ハンドルが破棄されたときにおこなわれます。 + 書込は cURL ハンドルが破棄されたときに行われます。 cURL 7.9.0 以降で利用可能です。 @@ -2762,7 +2762,7 @@ - 1 を指定すると、HTTP のプロキシを経由しておこなわれる FTP 転送の転送モード (バイナリないし ASCII) を設定するために + 1 を指定すると、HTTP のプロキシを経由して行われる FTP 転送の転送モード (バイナリないし ASCII) を設定するために URL へ type=a または type=i を付加するようになります。 この設定がなかったり 0 に設定されていたりする場合、 プロキシ経由で FTP を実行するにあたって From bf47e32b8d3fad177cfcb0d49dd91eb616b2b26a Mon Sep 17 00:00:00 2001 From: nsfisis Date: Mon, 13 Oct 2025 21:12:04 +0900 Subject: [PATCH 5/6] =?UTF-8?q?=E8=AA=AD=E7=82=B9=E3=82=92=E8=BF=BD?= =?UTF-8?q?=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- reference/curl/constants_curl_setopt.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/reference/curl/constants_curl_setopt.xml b/reference/curl/constants_curl_setopt.xml index 5d31fee8b7..ab1a3b1ff6 100644 --- a/reference/curl/constants_curl_setopt.xml +++ b/reference/curl/constants_curl_setopt.xml @@ -357,15 +357,15 @@ ALL - はメモリ上に保持されているすべてのクッキーを削除し + はメモリ上に保持されているすべてのクッキーを削除し、 SESS - はメモリ上に保持されているすべてのセッションクッキーを削除し + はメモリ上に保持されているすべてのセッションクッキーを削除し、 FLUSH - は CURLOPT_COOKIEJAR で指定されたファイルにすべてのクッキーを書き出し + は CURLOPT_COOKIEJAR で指定されたファイルにすべてのクッキーを書き出し、 RELOAD From ececc0e49432d04a87fa70a95f8992e829c9f1ab Mon Sep 17 00:00:00 2001 From: nsfisis Date: Mon, 13 Oct 2025 21:29:15 +0900 Subject: [PATCH 6/6] Apply suggestions from code review Co-authored-by: Yoshinari Takaoka --- reference/curl/constants_curl_setopt.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/reference/curl/constants_curl_setopt.xml b/reference/curl/constants_curl_setopt.xml index ab1a3b1ff6..35cf4bd8fd 100644 --- a/reference/curl/constants_curl_setopt.xml +++ b/reference/curl/constants_curl_setopt.xml @@ -848,7 +848,7 @@ CURLOPT_TRANSFERTEXT のエイリアスです。そちらを使用してください。 cURL 7.1 以降で利用可能でしたが、cURL 7.11.1 からは非推奨となっており、 - cURL 7.15.5 を最後に削除されました。 + 最終的に cURL 7.15.5 まで利用可能でした。 PHP 7.3.0 で削除されました。 @@ -2793,7 +2793,7 @@ &true; を指定すると、cURL がタイムアウトから復帰する際に、リソースの解放処理をスキップします。 - これにより、関連リソースがリークする可能性を犠牲に、 + これにより、関連リソースがリークする可能性を犠牲にして、 cURL プロセスを迅速に終了できるようになります。 PHP 8.3.0 以降かつ cURL 7.87.0 以降で利用可能です。 @@ -3054,7 +3054,7 @@ 次の RTSP リクエストに対して発行する CSEQ 番号を int で指定します。 - アプリケーションが断絶された接続を再開するときに有用です。 + アプリケーションが以前切断された接続を再開するときに有用です。 以後 CSEQ はこの新しい番号からインクリメントされます。 デフォルト値は 0 です。 cURL 7.20.0 以降で利用可能です。