diff --git a/reference/curl/constants_curl_setopt.xml b/reference/curl/constants_curl_setopt.xml new file mode 100644 index 0000000000..82ad660b1e --- /dev/null +++ b/reference/curl/constants_curl_setopt.xml @@ -0,0 +1,4678 @@ + + + + + <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. + PHP 7.3.0 以降かつ cURL 7.53.0 以降で利用可能です。 + + + + + + CURLOPT_ACCEPT_ENCODING + (int) + + + + HTTP リクエストの中で送られる Accept-Encoding: ヘッダーの内容を + string で指定します。 + &null; をセットすると、Accept-Encoding: ヘッダーの送信を無効にします。 + デフォルト値は &null; です。 + cURL 7.21.6 以降で利用可能です。 + + + + + + CURLOPT_ACCEPTTIMEOUT_MS + (int) + + + + !!! "active FTP connection" + アクティブな FTP 接続を使用している場合に、 + cURL がサーバーからの接続を待機する最大ミリ秒数を指定します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 60000 ミリ秒です。 + cURL 7.24.0 以降で利用可能です。 + + + + + + CURLOPT_ADDRESS_SCOPE + (int) + + + + IPv6 アドレスに接続する際に使用するスコープ ID の値を指定します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 0 です。 + cURL 7.19.0 以降で利用可能です。 + + + + + + CURLOPT_ALTSVC + (int) + + + + !!! Alt-Svc + 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. + PHP 8.2.0 以降かつ cURL 7.64.1 以降で利用可能です。 + + + + + + CURLOPT_ALTSVC_CTRL + (int) + + + + !!! Alt-Svc + 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. + PHP 8.2.0 以降かつ cURL 7.64.1 以降で利用可能です。 + + + + + + CURLOPT_APPEND + (int) + + + + このオプションを 1 に設定すると、FTP アップロード時に + リモートファイルを上書きするのではなく、末尾に追加するようになります。 + デフォルト値は 0 です。 + cURL 7.17.0 以降で利用可能です。 + + + + + + CURLOPT_AUTOREFERER + (int) + + + + &true; を指定すると、リクエストが Location: のリダイレクトによるものである場合、 + 自動的に Referer: ヘッダーを設定します。 + デフォルト値は 0 です。 + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_AWS_SIGV4 + (int) + + + + AWS V4 署名認証を HTTP(S) ヘッダーに string として指定します。 + このオプションは、CURLOPT_HTTPAUTH で設定された + 他の認証方法を上書きします。これと他の認証方法を組み合わせることはできません。 + PHP 8.2.0 以降かつ cURL 7.75.0 以降で利用可能です。 + + + + + + CURLOPT_BINARYTRANSFER + (int) + + + + この定数は PHP 5.5.0 以降は用いられていません。 + PHP 8.4.0 以降は非推奨となっています。 + + + + + + CURLOPT_BUFFERSIZE + (int) + + + + 各読込で使用するバッファサイズを設定します。 + ただし、必ずしも指定した値が使われるとは限りません。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は CURL_MAX_WRITE_SIZE (現在は 16kB) です。 + cURL 7.10 以降で利用可能です。 + + + + + + CURLOPT_CAINFO + (int) + + + + !!! CURLOPT_CAINFO_BLOB との差は? + 相手を検証するための証明書を格納したファイル名を string で指定します。 + このオプションは、CURLOPT_SSL_VERIFYPEER と組み合わせて用いた場合のみ意味を持ちます。 + 絶対パスを指定する必要があるかもしれません。 + cURL 7.4.2 以降で利用可能です。 + + + + + + CURLOPT_CAINFO_BLOB + (int) + + + + !!! CURLOPT_CAINFO との差は? + 相手を検証するための証明書を格納した PEM ファイル名を string で指定します。 + このオプションは CURLOPT_CAINFO を上書きします。 + PHP 8.2.0 以降かつ cURL 7.77.0 以降で利用可能です。 + + + + + + CURLOPT_CAPATH + (int) + + + + CA 証明書を格納したディレクトリを string で指定します。 + CURLOPT_SSL_VERIFYPEER と一緒に使用してください。 + cURL 7.9.8 以降で利用可能です。 + + + + + + CURLOPT_CA_CACHE_TIMEOUT + (int) + + + + CA 証明書ストアのインメモリキャッシュが保持され、新しい接続に再利用される + 最大時間を秒単位で指定します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 86400 (24 時間) です。 + PHP 8.3.0 以降かつ cURL 7.87.0 以降で利用可能です。 + + + + + + CURLOPT_CERTINFO + (int) + + + + &true; に設定すると、暗号化された通信の際に + SSL 認証情報を STDERR へ出力します。 + CURLOPT_VERBOSE を有効にしている場合にのみ効果があります。 + デフォルト値は &false; です。 + cURL 7.19.1 以降で利用可能です。 + + + + + + CURLOPT_CONNECTTIMEOUT + (int) + + + + 接続するまでの最大待機秒数を指定します。 + 0 を指定するといつまでも待機します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 300 です。 + cURL 7.7.0 以降で利用可能です。 + + + + + + CURLOPT_CONNECTTIMEOUT_MS + (int) + + + + 接続するまでの最大待機ミリ秒数を指定します。 + 0 を指定するといつまでも待機します。 + !!! "standard system name resolver" をどう訳すか考える + 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. + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 300000 です。 + cURL 7.16.2 以降で利用可能です。 + + + + + + CURLOPT_CONNECT_ONLY + (int) + + + + &true; を指定すると、必要なプロキシの認証をおこなって接続を確立するだけで、 + データ転送をおこなわなくなります。このオプションは + HTTP、SMTP、POP3 で実装されています。 + デフォルト値は &false; です。 + cURL 7.15.2 以降で利用可能です。 + + + + + + CURLOPT_CONNECT_TO + (int) + + + + URL のホストとポートの代わりに、指定したホストとポートに接続します。 + HOST:PORT:CONNECT-TO-HOST:CONNECT-TO-PORT の形式の + stringarray で受け付けます。 + PHP 7.0.7 以降かつ cURL 7.49.0 以降で利用可能です。 + + + + + + CURLOPT_COOKIE + (int) + + + + HTTP リクエストの中で使われる Cookie: ヘッダーの内容を string で指定します。 + 複数のクッキーを指定する場合はセミコロンとスペースで区切ります (例: fruit=apple; colour=red)。 + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_COOKIEFILE + (int) + + + + クッキーデータを格納したファイル名を string で指定します。 + クッキーファイルは Netscape 形式か、通常の HTTP スタイルのヘッダーをそのままファイルにダンプしたものです。 + ファイル名が空の string の場合、クッキーは読み込まれませんが、クッキーの処理は + おこなわれます。 + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_COOKIEJAR + (int) + + + + cURL が保持しているすべてのクッキーを保存するファイル名を string で指定します。 + 書込は cURL ハンドルが破棄されたときにおこなわれます。 + cURL 7.9.0 以降で利用可能です。 + + + PHP 8.0.0 以降、curl_close は + 何もしなくなり、ハンドルを破棄 しなく なりました。 + ハンドラが自動的に破棄されるよりも前にクッキーを書き出す必要がある場合、 + ハンドルに対して unset を呼び出してください。 + + + + + + + + CURLOPT_COOKIELIST + (int) + + + + string で指定されたクッキーを内部のクッキーストアに追加します。 + この文字列は Nescape/Mozilla 形式の単一行、または通常の HTTP スタイルの Set-Cookie ヘッダーです。 + + + ALL + はメモリ上に保持されているすべてのクッキーを削除し + + + SESS + はメモリ上に保持されているすべてのセッションクッキーを削除し + + + FLUSH + は CURLOPT_COOKIEJAR で指定されたファイルにすべてのクッキーを書き出し + + + RELOAD + は CURLOPT_COOKIEFILE で指定されたファイルからすべてのクッキーを読み込みます + + 。 + 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. + cURL 7.9.7 以降で利用可能です。 + + + + + + CURLOPT_CRLF + (int) + + + + &true; を指定すると、Unix の改行コードを CRLF 改行コードに変換して + 送ります。 + 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. + 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. + このオプションは string ないし &null; を受け取ります。 + cURL 7.1.0 以降で利用可能です。 + + + Don't do this without making sure the server supports the custom + request method first. + + + + + + + + CURLOPT_DEFAULT_PROTOCOL + (int) + + + + URL がスキーム名を持たない場合に使用するデフォルトのプロトコルを string で指定します。 + PHP 7.0.7 以降かつ 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. + デフォルト値は 0 です。 + cURL 7.17.0 以降で利用可能です。 + + + + + + CURLOPT_DISALLOW_USERNAME_IN_URL + (int) + + + + &true; を指定すると、URL にユーザー名を含められなくなります。 + デフォルトではユーザー名を含められます。 + PHP 7.3.0 以降かつ cURL 7.61.0 以降で利用可能です。 + + + + + + CURLOPT_DNS_CACHE_TIMEOUT + (int) + + + + DNS のエントリーをメモリ上に保持する秒数を指定します。 + このオプションは、デフォルトで 120 (2分) に設定されています。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + cURL 7.9.3 以降で利用可能です。 + + + + + + CURLOPT_DNS_INTERFACE + (int) + + + + Set the name of the network interface that the DNS resolver should bind to. + アドレスではなくインターフェース名を指定する必要があります。 + このオプションは string ないし &null; を受け取ります。 + PHP 7.0.7 以降かつ 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. + このオプションは string ないし &null; を受け取ります。 + PHP 7.0.7 以降かつ 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. + このオプションは string ないし &null; を受け取ります。 + PHP 7.0.7 以降かつ cURL 7.33.0 以降で利用可能です。 + + + + + + CURLOPT_DNS_SERVERS + (int) + + + + システムのデフォルト DNS サーバーの代わりに使用する DNS サーバーのリストを + コンマ区切りの string で指定します + (例: 192.168.1.100,192.168.1.101:8080)。 + 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. + PHP 7.3.0 以降かつ 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.). + cURL 7.9.3 以降で利用可能ですが、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. + PHP 8.2.0 以降かつ 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. + PHP 8.2.0 以降かつ 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). + PHP 8.2.0 以降かつ cURL 7.76.0 以降で利用可能です。 + + + + + + CURLOPT_DOH_URL + (int) + + + + Provides the DNS-over-HTTPS URL. + このオプションは string ないし &null; を受け取ります。 + PHP 8.1.0 以降かつ cURL 7.62.0 以降で利用可能です。 + + + + + + CURLOPT_EGDSOCKET + (int) + + + + Like CURLOPT_RANDOM_FILE, except a filename + to an Entropy Gathering Daemon socket. + cURL 7.7.0 以降で利用可能ですが、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. + cURL 7.10 以降で利用可能ですが、cURL 7.21.6 以降は非推奨となりました。 + + + + + + CURLOPT_EXPECT_100_TIMEOUT_MS + (int) + + + + Expect: 100-continue レスポンスのタイムアウトをミリ秒で指定します。 + デフォルト値は 1000 ミリ秒です。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + PHP 7.0.7 以降かつ cURL 7.36.0 以降で利用可能です。 + + + + + + CURLOPT_FAILONERROR + (int) + + + + &true; を指定すると、返された HTTP コードが 400 以上だったときにエラー情報と共に失敗するようになります。 + デフォルトの挙動では、コードを無視して通常どおりページを返します。 + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_FILE + (int) + + + + 転送データを書き込むファイルのファイルハンドル resource を受け取ります。 + デフォルトは STDOUT (ブラウザウィンドウ) です。 + cURL 7.1.0 以降で利用可能ですが、cURL 7.9.7 以降は非推奨となりました。 + + + + + + CURLOPT_FILETIME + (int) + + + + &true; を指定すると、リモートのドキュメントの更新日時を取得しようとします。 + その値は、curl_getinfo に + CURLINFO_FILETIME オプションを使うことで取得できます。 + cURL 7.5.0 以降で利用可能です。 + + + + + + CURLOPT_FNMATCH_FUNCTION + (int) + + + + ワイルドカードのマッチングに用いられる callable を渡します。 + コールバックのシグニチャは以下のとおりです。 + + intcallback + resourcecurlHandle + stringpattern + stringstring + + + + curlHandle + + + cURL ハンドル。 + + + + + pattern + + + ワイルドカードパターン。 + + + + + string + + + ワイルドカードパターンとマッチしているか判定する string。 + + + + + この関数は、パターンが string とマッチしていれば CURL_FNMATCHFUNC_MATCH を、 + していなければ CURL_FNMATCHFUNC_NOMATCH を、 + エラー時は CURL_FNMATCHFUNC_FAIL を返さなければなりません。 + cURL 7.21.0 以降で利用可能です。 + + + + + + CURLOPT_FOLLOWLOCATION + (int) + + + + &true; を指定すると、サーバーから HTTP ヘッダーの一部として送られた Location: ヘッダーを + 追跡するようになります。 + CURLOPT_MAXREDIRS も合わせてご覧ください。 + この定数は open_basedir が有効になっていると利用できません。 + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_FORBID_REUSE + (int) + + + + &true; を指定すると、処理が完了したとき明示的に接続を閉じ、 + 再利用のためにプールしないようになります。 + cURL 7.7.0 以降で利用可能です。 + + + + + + CURLOPT_FRESH_CONNECT + (int) + + + + &true; を指定すると、キャッシュされた接続を使う代わりに + 必ず新しい接続を用います。 + cURL 7.7.0 以降で利用可能です。 + + + + + + CURLOPT_FTPAPPEND + (int) + + + + &true; を指定すると、リモートのファイルを上書きするのではなく、 + 追記するようになります。 + cURL 7.1.0 以降で利用可能ですが、cURL 7.16.4 以降は非推奨となりました。 + + + + + + CURLOPT_FTPASCII + (int) + + + + CURLOPT_TRANSFERTEXT のエイリアスです。そちらを使用してください。 + cURL 7.1 以降で利用可能でしたが、cURL 7.11.1 からは非推奨となっており、 + cURL 7.15.5 を最後に削除されました。 + PHP 7.3.0 で削除されました。 + + + + + + CURLOPT_FTPLISTONLY + (int) + + + + Set to &true; to only list the names of an FTP directory. + cURL 7.1.0 以降で利用可能ですが、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. + このオプションは string ないし &null; を受け取ります。 + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_FTPSSLAUTH + (int) + + + + Set the FTP over SSL authentication method (if activated) to any of the + CURLFTPAUTH_* constants. + デフォルト値は CURLFTPAUTH_DEFAULT です。 + 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. + デフォルト値は &null; です。 + 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. + 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. + 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. + デフォルト値は CURLFTPMETHOD_MULTICWD です。 + cURL 7.15.1 以降で利用可能です。 + + + + + + CURLOPT_FTP_RESPONSE_TIMEOUT + (int) + + + + FTP サーバーからのレスポンスを待機するタイムアウト秒数を指定します。 + このオプションは CURLOPT_TIMEOUT を上書きします。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + このオプション名は PHP 8.4.0 で CURLOPT_SERVER_RESPONSE_TIMEOUT + へ置き換えられました。 + cURL 7.10.8 以降で利用可能ですが、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. + cURL 7.15.0 以降で利用可能です。 + + + + + + CURLOPT_FTP_SSL + (int) + + + + cURL 7.11.0 以降で利用可能ですが、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. + デフォルト値は CURLFTPSSL_CCC_NONE です。 + 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. + 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. + 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. + デフォルト値は 0 です。 + 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. + デフォルト値は CURLGSSAPI_DELEGATION_NONE です。 + 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. + デフォルト値は CURL_HET_DEFAULT (現在は 200 ミリ秒) です。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + PHP 7.3.0 以降かつ 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. + PHP 7.3.0 以降かつ cURL 7.60.0 以降で利用可能です。 + + + + + + CURLOPT_HEADER + (int) + + + + &true; を指定すると、CURLOPT_WRITEFUNCTION で定義されたコールバックへと渡される出力に + ヘッダーが含まれるようになります。 + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_HEADERFUNCTION + (int) + + + + 以下のシグニチャの callable を指定します。 + + intcallback + resourcecurlHandle + stringheaderData + + + + curlHandle + + + cURL ハンドル。 + + + + + headerData + + + このコールバックが書き込まなければならないヘッダーデータ。 + + + + + このコールバックは、書き込んだバイト数を返さなければなりません。 + 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. + PHP 7.0.7 以降かつ 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. + PHP 8.2.0 以降かつ cURL 7.74.0 以降で利用可能です。 + + + + + + CURLOPT_HSTS_CTRL + (int) + + + + Accepts a bitmask of HSTS (HTTP Strict Transport Security) features + defined by the CURLHSTS_* constants. + PHP 8.2.0 以降かつ cURL 7.74.0 以降で利用可能です。 + + + + + + CURLOPT_HTTP09_ALLOWED + (int) + + + + HTTP/0.9 でのレスポンスを許可するかどうかを指定します。cURL 7.66.0 以降のデフォルト値は &false; です。 + それより前のバージョンでは &true; でした。 + PHP 7.3.15 および 7.4.3 以降かつ cURL 7.64.0 以降で利用可能です。 + + + + + + CURLOPT_HTTP200ALIASES + (int) + + + + An array of HTTP 200 responses that will be treated as valid responses and not as errors. + cURL 7.10.3 以降で利用可能です。 + + + + + + CURLOPT_HTTPAUTH + (int) + + + + 使用する HTTP 認証方法のビットマスクです。選択肢は以下のとおりです。 + + CURLAUTH_BASIC + CURLAUTH_DIGEST + CURLAUTH_GSSNEGOTIATE + CURLAUTH_NTLM + CURLAUTH_AWS_SIGV4 + CURLAUTH_ANY + CURLAUTH_ANYSAFE + + 2つ以上の認証方法を指定した場合、cURL はサーバーがどの認証方法をサポートしているか + 問い合わせ、最適なものを選択します。 + CURLAUTH_ANY は全ビットをオンにします。cURL は自動的に + 最も安全だと思われるものを選択します。 + CURLAUTH_ANYSAFE は、CURLAUTH_BASIC を除いた全ビットをオンにします。 + cURL は自動的に最も安全だと思われるものを選択します。 + cURL 7.10.6 以降で利用可能です。 + + + + + + CURLOPT_HTTPGET + (int) + + + + &true; を指定すると、HTTP リクエストのメソッドを GET にリセットします。 + デフォルトは GET のため、これが必要なのはリクエストメソッドが変更されていた場合のみです。 + cURL 7.8.1 以降で利用可能です。 + + + + + + CURLOPT_HTTPHEADER + (int) + + + + HTTP ヘッダーフィールドの array を指定します。各要素の形式は以下のとおりです。 + + array('Content-type: text/plain', 'Content-length: 100') + + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_HTTPPROXYTUNNEL + (int) + + + + &true; to tunnel through a given HTTP proxy. + cURL 7.3.0 以降で利用可能です。 + + + + + + CURLOPT_HTTP_CONTENT_DECODING + (int) + + + + &false; を指定すると、生の HTTP レスポンスボディを取得できます。 + cURL 7.16.2 以降で利用可能です。 + + + + + + CURLOPT_HTTP_TRANSFER_DECODING + (int) + + + + !!! "chunked transfer decoding" の訳 + 0 を指定すると転送時のデコード処理を無効にします。 + 1 を指定すると転送時のデコード処理を有効にします。 + このオプションを 0 に設定しない限り、 + cURL は "chunked transfer decoding" をデフォルトでおこないます。 + デフォルト値は 1 です。 + cURL 7.16.2 以降で利用可能です。 + + + + + + CURLOPT_HTTP_VERSION + (int) + + + + CURL_HTTP_VERSION_* 定数のいずれかを指定することで、 + cURL に指定した HTTP バージョンを使わせることができます。 + 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. + デフォルト値は 0 です。 + cURL 7.14.1 以降で利用可能です。 + + + + + + CURLOPT_INFILE + (int) + + + + Accepts a file handle resource + to the file that the transfer should be read from when uploading. + cURL 7.1.0 以降で利用可能ですが、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. + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_INTERFACE + (int) + + + + 使用する送信ネットワークインターフェースの名前を string で指定します。 + インターフェース名、IP アドレス、ホスト名のいずれかが指定できます。 + 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. + デフォルト値は CURL_IPRESOLVE_WHATEVER です。 + 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. + 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. + PHP 8.1.0 以降かつ 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. + PHP 7.3.0 以降かつ 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. + 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. + cURL 7.3.0 以降で利用可能ですが、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. + デフォルト値は &null; です。 + cURL 7.16.4 以降で利用可能です。 + + + + + + CURLOPT_LOCALPORT + (int) + + + + 接続に用いるソケットのローカルポート番号を指定します。 + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 0 です。 + 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. + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 1 です。 + 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. + PHP 7.0.7 以降かつ 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. + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + 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. + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + 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. + 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. + 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. + 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. + cURL 8.2.0 で CURLOPT_MAIL_RCPT_ALLOWFAILS に置き換えられました。 + PHP 8.2.0 以降かつ cURL 7.69.0 以降で利用可能です。 + 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. + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + PHP 8.2.0 以降かつ 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. + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + 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. + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + デフォルト値は 0 です。 + 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. + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + PHP 8.2.0 以降かつ 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. + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + PHP 8.2.0 以降かつ cURL 7.80.0 以降で利用可能です。 + + + + + + CURLOPT_MAXREDIRS + (int) + + + + HTTP リダイレクトの最大回数を指定します。CURLOPT_FOLLOWLOCATION と合わせて使用してください。 + デフォルト値の 20 は、無限リダイレクトを防ぐために設定されています。 + -1 を指定すると何度でもリダイレクトするようになります。0 を指定すると一切リダイレクトしなくなります。 + 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. + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + 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. + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + cURL 7.15.5 以降で利用可能です。 + + + + + + CURLOPT_MIME_OPTIONS + (int) + + + + Set to a bitmask of CURLMIMEOPT_* + constants. Currently there is only one available option: + CURLMIMEOPT_FORMESCAPE. + PHP 8.3.0 以降かつ cURL 7.81.0 以降で利用可能です。 + + + + + + CURLOPT_MUTE + (int) + + + + Set to &true; to be completely silent with regards to + the cURL functions. + Use CURLOPT_RETURNTRANSFER instead. + cURL 7.1.0 以降で利用可能でしたが、cURL 7.8.0 からは非推奨となっており、 + cURL 7.15.5 を最後に削除されました。 + 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. + 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. + 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://. + 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://. + 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. + 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. + + + 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. + 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. + cURL 7.10 以降で利用可能です。 + + + + + + CURLOPT_PASSWDFUNCTION + (int) + + + + 以下のシグニチャの callable を指定します。 + + stringcallback + resourcecurlHandle + stringpasswordPrompt + intmaximumPasswordLength + + + + curlHandle + + + cURL ハンドル。 + + + + + passwordPrompt + + + パスワードプロンプト。 + + + + + maximumPasswordLength + + + パスワードの最大長。 + + + + + このコールバックは、パスワードが入った string を返さなければなりません。 + cURL 7.4.2 以降で利用可能でしたが、cURL 7.11.1 からは非推奨となっており、 + cURL 7.15.5 を最後に削除されました。 + PHP 7.3.0 で削除されました。 + + + + + + CURLOPT_PASSWORD + (int) + + + + Set to a string with the password to use in authentication. + 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. + PHP 7.0.7 以降かつ 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 ;. + PHP 7.0.7 以降かつ 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. + PHP 7.0.7 以降かつ 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. + 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. + デフォルト値は &false; です。 + 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. + 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. + 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. + 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. + PHP 7.3.0 以降かつ 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. + 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. + cURL 7.10.3 以降で利用可能です。 + + + + + + CURLOPT_PROGRESSFUNCTION + (int) + + + + 以下のシグニチャの callable を指定します。 + + intcallback + resourcecurlHandle + intbytesToDownload + intbytesDownloaded + intbytesToUpload + intbytesUploaded + + + + curlHandle + + + cURL ハンドル。 + + + + + bytesToDownload + + + この転送でダウンロードされようとしている総バイト数。 + + + + + bytesDownloaded + + + これまでにダウンロードされたバイト数。 + + + + + bytesToUpload + + + この転送でアップロードされようとしている総バイト数。 + + + + + bytesUploaded + + + これまでにアップロードされたバイト数。 + + + + + 転送を中断し、CURLE_ABORTED_BY_CALLBACK エラーをセットするには、 + このコールバックから非ゼロの int を返してください。 + + + このコールバックが呼ばれるのは、CURLOPT_NOPROGRESS オプションが + &false; に設定されている場合のみです。 + + + cURL 7.1.0 以降で利用可能ですが、cURL 7.32.0 以降は非推奨となりました。 + 代わりに CURLOPT_XFERINFOFUNCTION を用いてください。 + + + + + + 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. + cURL 7.19.4 以降で利用可能ですが、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 + . + PHP 8.3.0 以降かつ 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]. + 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. + デフォルト値は CURLAUTH_BASIC です。 + cURL 7.10.7 以降で利用可能です。 + + + + + + CURLOPT_PROXYHEADER + (int) + + + + An array of custom HTTP header strings to pass to proxies. + PHP 7.0.7 以降かつ cURL 7.37.0 以降で利用可能です。 + + + + + + CURLOPT_PROXYPASSWORD + (int) + + + + Set a string with the password to be used for authentication with the proxy. + 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. + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_PROXYTYPE + (int) + + + + Sets the type of the proxy to one of the + CURLPROXY_* constants. + デフォルト値は CURLPROXY_HTTP です。 + cURL 7.10 以降で利用可能です。 + + + + + + CURLOPT_PROXYUSERNAME + (int) + + + + Set a string with the username to be used for authentication with the proxy. + 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. + 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. + PHP 7.3.0 以降かつ 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. + PHP 8.2.0 以降かつ cURL 7.77.0 以降で利用可能です。 + + + + + + CURLOPT_PROXY_CAPATH + (int) + + + + A string with the directory holding multiple CA certificates + to verify the HTTPS proxy with. + PHP 7.3.0 以降かつ 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. + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 + + + + + + CURLOPT_PROXY_ISSUERCERT + (int) + + + + Proxy issuer SSL certificate filename string. + PHP 8.1.0 以降かつ cURL 7.71.0 以降で利用可能です。 + + + + + + CURLOPT_PROXY_ISSUERCERT_BLOB + (int) + + + + A string with the proxy issuer SSL certificate. + PHP 8.1.0 以降かつ 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. + PHP 7.3.0 以降かつ 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 ;. + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 + + + + + + CURLOPT_PROXY_SERVICE_NAME + (int) + + + + A string with the proxy authentication service name. + PHP 7.0.7 以降かつ、HTTP プロキシを使う場合は cURL 7.43.0 以降、SOCKS5 プロキシを使う場合は cURL 7.49.0 以降で利用可能です。 + + + + + + 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. + PHP 7.3.0 以降かつ 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. + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 + + + + + + CURLOPT_PROXY_SSLCERT_BLOB + (int) + + + + A string with the SSL proxy client certificate. + PHP 8.1.0 以降かつ 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. + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 + + + + + + CURLOPT_PROXY_SSLKEYTYPE + (int) + + + + A string with the format of the private key. + Supported formats are: + + PEM + DER + ENG + . + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 + + + + + + CURLOPT_PROXY_SSLKEY_BLOB + (int) + + + + A string with the private key for connecting to the HTTPS proxy. + PHP 8.1.0 以降かつ cURL 7.71.0 以降で利用可能です。 + + + + + + CURLOPT_PROXY_SSLVERSION + (int) + + + + Set the preferred HTTPS proxy TLS version to one of the + CURL_SSLVERSION_* + constants. + デフォルト値は 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. + + + PHP 7.3.0 以降かつ 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. + PHP 7.3.0 以降かつ cURL 7.52.0 以降で利用可能です。 + + + + + + CURLOPT_PROXY_SSL_OPTIONS + (int) + + + + Set proxy SSL behavior options, which is a bitmask of the + CURLSSLOPT_* constants. + PHP 7.3.0 以降かつ 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. + cURL 7.66.0 以降では 12 と同じ値として扱われます。 + デフォルト値は 2 です。 + In production environments the value of this option should be kept at 2. + PHP 7.3.0 以降かつ 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. + PHP 7.3.0 以降かつ 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. + PHP 7.3.0 以降かつ 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. + PHP 7.3.0 以降かつ 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. + + + PHP 7.3.0 以降かつ 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. + PHP 7.3.0 以降かつ 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. + デフォルト値は 0 です。 + 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. + cURL 7.1.0 以降で利用可能ですが、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. + PHP 8.3.0 以降かつ cURL 7.87.0 以降で利用可能です。 + + + + + + CURLOPT_QUOTE + (int) + + + + An array of FTP command strings to execute on the server prior to the FTP request. + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_RANDOM_FILE + (int) + + + + A string with a filename to be used to seed the random number generator for SSL. + cURL 7.7.0 以降で利用可能ですが、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. + 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. + cURL 7.9.7 以降で利用可能です。 + + + + + + CURLOPT_READFUNCTION + (int) + + + + 以下のシグニチャの callable を指定します。 + + stringcallback + resourcecurlHandle + resourcestreamResource + intmaxAmountOfDataToRead + + + + curlHandle + + + cURL ハンドル。 + + + + + streamResource + + + CURLOPT_READDATA オプションを通して + cURL へと渡されたストリーム resource。 + + + + + maxAmountOfDataToRead + + + 読み出すべきデータの最大長。 + + + + + このコールバックは、要求されたデータ長以下の string を + 返さなければなりません。 + 典型的には、渡されたストリーム resource からデータを読み出して返します。 + EOF を伝えるためには空の string を返してください。 + 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. + cURL 7.19.4 以降で利用可能ですが、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 + . + PHP 8.3.0 以降かつ cURL 7.85.0 以降で利用可能です。 + + + + + + CURLOPT_REFERER + (int) + + + + A string with the contents of the Referer: + header to be used in a HTTP request. + 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. + PHP 7.3.0 以降かつ 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", + ) + + cURL 7.21.3 以降で利用可能です。 + + + + + + CURLOPT_RESUME_FROM + (int) + + + + The offset, in bytes, to resume a transfer from. + このオプションは、有効な int にキャストできる任意の値を受け付けます。 + 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. + デフォルト値は 0 です。 + cURL 7.20.0 以降で利用可能です。 + + + + + + CURLOPT_RTSP_REQUEST + (int) + + + + Sets the kind of RTSP request to make. + Must be one of the CURL_RTSPREQ_* + constants. + 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. + デフォルト値は 0 です。 + 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; + 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. + cURL 7.20.0 以降で利用可能です。 + + + + + + CURLOPT_RTSP_TRANSPORT + (int) + + + + Set the Transport: header for this RTSP session. + 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. + PHP 8.2.0 以降かつ cURL 7.66.0 以降で利用可能です。 + + + + + + CURLOPT_SASL_IR + (int) + + + + &true; to enable sending the initial response in the first packet. + PHP 7.0.7 以降かつ cURL 7.31.0 以降で利用可能です。 + + + + + + CURLOPT_SERVICE_NAME + (int) + + + + A string with the authentication service name. + PHP 7.0.7 以降かつ 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. + 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. + デフォルト値は CURLAUTH_BASIC|CURLAUTH_GSSAPI です。 + Set the actual username and password with the CURLOPT_PROXYUSERPWD option. + PHP 7.3.0 以降かつ 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. + cURL 7.19.4 以降で利用可能です。 + + + + + + CURLOPT_SOCKS5_GSSAPI_SERVICE + (int) + + + + Set a string holding the name of the SOCKS5 service. + デフォルト値は rcmd です。 + cURL 7.19.4 以降で利用可能ですが、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 + . + デフォルト値は CURLSSH_AUTH_ANY です。 + 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. + デフォルト値は &false; です。 + PHP 7.3.0 以降かつ cURL 7.56.0 以降で利用可能です。 + + + + + + CURLOPT_SSH_HOSTKEYFUNCTION + (int) + + + + SSH ホストキーの検証が必要になった場合に呼ばれる callable を指定します。 + このコールバックは、以下のシグニチャである必要があります。 + + intcallback + resourcecurlHandle + intkeyType + stringkey + intkeyLength + + + + curlHandle + + + cURL ハンドル。 + + + + + keyType + + + CURLKHTYPE_* のうちいずれかのキーの種類。 + + + + + key + + + チェックするキー。 + + + + + keyLength + + + キーのバイト長。 + + + + + このコールバックは CURLOPT_SSH_KNOWNHOSTS を上書きします。 + PHP 8.3.0 以降かつ 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. + 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. + PHP 8.2.0 以降かつ 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. + 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. + 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. + cURL 7.16.1 以降で利用可能です。 + + + + + + CURLOPT_SSLCERT + (int) + + + + The name of a file containing a PEM formatted certificate. + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_SSLCERTPASSWD + (int) + + + + The password required to use the + CURLOPT_SSLCERT certificate. + cURL 7.1.0 以降で利用可能ですが、cURL 7.17.0 以降は非推奨となりました。 + + + + + + CURLOPT_SSLCERTTYPE + (int) + + + + 証明書のフォーマットを string で指定します。サポートされているフォーマット: + + PEM + DER + ENG + P12 + . + P12 (PKCS#12 でエンコードされたファイル用) は OpenSSL 0.9.3 以降で利用可能です。 + デフォルト値は PEM です。 + cURL 7.9.3 以降で利用可能です。 + + + + + + CURLOPT_SSLCERT_BLOB + (int) + + + + SSL のクライアント証明書を string で指定します。 + PHP 8.1.0 以降かつ cURL 7.71.0 以降で利用可能です。 + + + + + + CURLOPT_SSLENGINE + (int) + + + + The string identifier for the crypto engine of the private SSL key + specified in CURLOPT_SSLKEY. + cURL 7.9.3 以降で利用可能です。 + + + + + + CURLOPT_SSLENGINE_DEFAULT + (int) + + + + The string identifier for the crypto engine used for asymmetric crypto + operations. + cURL 7.9.3 以降で利用可能です。 + + + + + + CURLOPT_SSLKEY + (int) + + + + The name of a file containing a private SSL key. + 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. + + + cURL 7.9.3 以降で利用可能ですが、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 + . + デフォルト値は PEM です。 + cURL 7.9.3 以降で利用可能です。 + + + + + + CURLOPT_SSLKEY_BLOB + (int) + + + + A string private key for client cert. + PHP 8.1.0 以降かつ 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. + + + デフォルト値は CURL_SSLVERSION_DEFAULT です。 + 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. + 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. + PHP 8.2.0 以降かつ 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. + PHP 7.0.7 以降かつ 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. + PHP 7.0.7 以降かつ cURL 7.36.0 以降で利用可能ですが、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. + PHP 7.0.7 以降かつ 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. + PHP 7.0.7. 以降かつ 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. + 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. + 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. + cURL 7.10 以降のデフォルト値は &true; です。 + Default bundle of CA certificates installed as of cURL 7.10. + cURL 7.4.2 以降で利用可能です。 + + + + + + CURLOPT_SSL_VERIFYSTATUS + (int) + + + + &true; to enable and &false; to disable verification of the certificate's status. + PHP 7.0.7 以降かつ cURL 7.41.0 以降で利用可能です。 + + + + + + CURLOPT_STDERR + (int) + + + + Accepts a file handle resource pointing to + an alternative location to output errors to instead of + STDERR. + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_STREAM_WEIGHT + (int) + + + + Set the numerical stream weight (a number between 1 and 256). + PHP 7.0.7 以降かつ 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. + デフォルト値は &false; です。 + PHP 7.3.0 以降かつ cURL 7.54.0 以降で利用可能です。 + + + + + + CURLOPT_TCP_FASTOPEN + (int) + + + + &true; to enable and &false; to disable TCP Fast Open. + PHP 7.0.7 以降かつ 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. + 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. + 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. + cURL 7.25.0 以降で利用可能です。 + + + + + + CURLOPT_TCP_KEEPCNT + (int) + + + + Sets the maximum number of TCP keep-alive probes. + The default is 9. + PHP 8.4.0 以降かつ 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. + デフォルト値は &true; です。 + 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. + 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. + cURL 7.19.4 以降で利用可能です。 + + + + + + CURLOPT_TFTP_NO_OPTIONS + (int) + + + + &true; to not send TFTP options requests. + デフォルト値は &false; です。 + PHP 7.0.7 以降かつ 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. + 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. + 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. + cURL 7.16.2 以降で利用可能です。 + + + + + + CURLOPT_TIMEVALUE + (int) + + + + The time in seconds since January 1st, 1970. The time will be used + by CURLOPT_TIMECONDITION. + デフォルト値は 0 です。 + 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. + PHP 7.3.0 以降かつ 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. + PHP 7.3.0 以降かつ 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. + 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). + 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. + 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. + デフォルト値は 0 です。 + 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. + デフォルト値は &false; です。 + 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. + デフォルト値は &null; です。 + PHP 7.0.7 以降かつ 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. + デフォルト値は &false; です。 + 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. + PHP 8.2.0 以降かつ cURL 7.62.0 以降で利用可能です。 + + + + + + CURLOPT_UPLOAD + (int) + + + + &true; to prepare for and perform an upload. + デフォルト値は &false; です。 + 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. + PHP 8.2.0 以降かつ cURL 7.62.0 以降で利用可能です。 + + + + + + CURLOPT_URL + (int) + + + + 取得する URL を指定します。この設定は curl_init で + セッションを初期化する際にも指定できます。 + 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. + cURL 7.17.0 以降で利用可能です。 + + + + + + CURLOPT_USERAGENT + (int) + + + + HTTP リクエストで使われる User-Agent: ヘッダーの内容を指定します。 + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_USERNAME + (int) + + + + 認証に用いるユーザー名を指定します。 + cURL 7.19.1 以降で利用可能です。 + + + + + + CURLOPT_USERPWD + (int) + + + + [username]:[password] の形で + 接続に用いるユーザー名とパスワードを指定します。 + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_VERBOSE + (int) + + + + &true; を指定すると、詳細な情報を出力します。 + 出力は STDERR か、 + CURLOPT_STDERR で指定されたファイルへと書き込まれます。 + デフォルト値は &false; です。 + 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). + cURL 7.21.0 以降で利用可能です。 + + + + + + CURLOPT_WRITEFUNCTION + (int) + + + + 以下のシグニチャの callable を指定します。 + + intcallback + resourcecurlHandle + stringdata + + + + curlHandle + + + cURL ハンドル。 + + + + + data + + + 書き込むべきデータ。 + + + + + このコールバックは、データを保存して書き込んだバイト数を返さなければなりません。 + そうしないなら、転送はエラーで中止されます (訳注: 一度にすべてのデータを書き込む必要があり、部分的な書き込みはできません。つまり、返り値は渡されたデータ長と一致しなければなりません)。 + 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. + cURL 7.1.0 以降で利用可能です。 + + + + + + CURLOPT_WS_OPTIONS + (int) + + + + Accepts a bitmask setting WebSocket behavior options. + The only available option is CURLWS_RAW_MODE. + デフォルト値は 0 です。 + PHP 8.3.0 以降かつ cURL 7.86.0 以降で利用可能です。 + + + + + + CURLOPT_XFERINFOFUNCTION + (int) + + + + 以下のシグニチャの callable を指定します。 + + intcallback + resourcecurlHandle + intbytesToDownload + intbytesDownloaded + intbytesToUpload + intbytesUploaded + + + + curlHandle + + + cURL ハンドル。 + + + + + bytesToDownload + + + この転送でダウンロードされようとしている総バイト数。 + + + + + bytesDownloaded + + + これまでにダウンロードされたバイト数。 + + + + + bytesToUpload + + + この転送でアップロードされようとしている総バイト数。 + + + + + bytesUploaded + + + これまでにアップロードされたバイト数。 + + + + + 転送を中断し、CURLE_ABORTED_BY_CALLBACK エラーをセットするには、 + 1 を返してください。 + PHP 8.2.0 以降かつ cURL 7.32.0 以降で利用可能です。 + + + + + + CURLOPT_SERVER_RESPONSE_TIMEOUT + (int) + + + + サーバーからのレスポンスを cURL が待機するタイムアウト秒数を指定します。この設定が使われるのは、 + FTP サーバー、SFTP サーバー、IMAP サーバー、 + SCP サーバー、SMTP サーバー、POP3 サーバーです。 + このオプションは、cURL 7.85.0 で非推奨となった + CURLOPT_FTP_RESPONSE_TIMEOUT を置き換えます。 + PHP 8.4.0 以降で利用可能です。 + + + + + + CURLOPT_XOAUTH2_BEARER + (int) + + + + Specifies the OAuth 2.0 access token. + Set to &null; to disable. + デフォルト値は &null; です。 + PHP 7.0.7 以降かつ cURL 7.33.0 以降で利用可能です。 + + + + + + CURLOPT_PREREQFUNCTION + (int) + + + + 以下のシグニチャを持つ callable を指定します。 + このコールバックは、接続が確立され、リクエストペイロード + (例えば、HTTP 接続における GET/POST/DELETE リクエスト) が送られる前に呼ばれます。 + 送信元/送信先 IP アドレスやポート番号に応じて接続を中止したり許可したりするのに + 用いることができます。 + + intcallback + CurlHandlecurlHandle + stringdestination_ip + stringlocal_ip + intdestination_port + intlocal_port + + + + curlHandle + + + cURL ハンドル。 + + + + + destination_ip + + + この接続で確立されたリモートサーバーのプライマリー IP アドレス。 + FTP の場合は、制御用接続の IP アドレスになります。 + IPv6 のアドレスは、角括弧で囲わずに表現されます。 + + + + + local_ip + + + この接続の送信元 IP アドレス。 + IPv6 のアドレスは、角括弧で囲わずに表現されます。 + + + + + destination_port + + + この接続で確立されたリモートサーバーのプライマリーポート番号。 + FTP の場合は、制御用接続のポート番号になります。 + プロトコルに応じて、TCP または UDP のポート番号になります。 + + + + + local_port + + + この接続の送信元ポート番号。 + プロトコルに応じて、TCP または UDP のポート番号になります。 + + + + + リクエストを許可する場合は CURL_PREREQFUNC_OK を、 + 転送を中止する場合は CURL_PREREQFUNC_ABORT を返してください。 + PHP 8.4.0 以降かつ cURL 7.80.0 以降で利用可能です。 + + + + + + CURLOPT_DEBUGFUNCTION + (int) + + + + PHP 8.4.0 以降で利用可能です。 + このオプションを利用するには CURLOPT_VERBOSE オプションを有効にする必要があります。 + cURL 標準の詳細出力を置き換える callable を指定します。 + このコールバックは、リクエストのさまざまな段階で詳細なデバッグ情報とともに呼び出されます。 + これは以下のシグニチャである必要があります。 + + voidcallback + CurlHandlecurlHandle + inttype + stringdata + + + + curlHandle + + + cURL ハンドル。 + + + + + type + + + data の値の種類を表す以下の定数のいずれか: + + + + + CURLINFO_TEXT + (int) + + + + なんらかの情報を表すテキスト。 + + + + + + CURLINFO_HEADER_IN + (int) + + + + 相手から受信したヘッダー (あるいはヘッダーのような) データ。 + + + + + + CURLINFO_HEADER_OUT + (int) + + + + 相手に送信したヘッダー (あるいはヘッダーのような) データ。 + + + + + + CURLINFO_DATA_IN + (int) + + + + 相手から受信した未処理のプロトコルデータ。 + データがエンコードされていたり圧縮されていたりしたとしても、デコードされたデータや展開されたデータがコールバックへ渡されることはありません。 + + + + + + CURLINFO_DATA_OUT + (int) + + + + 相手に送信したプロトコルデータ。 + + + + + + CURLINFO_SSL_DATA_IN + (int) + + + + 相手から受信した SSL/TLS の (バイナリ) データ。 + + + + + + CURLINFO_SSL_DATA_OUT + (int) + + + + 相手に送信した SSL/TLS の (バイナリ) データ。 + + + + + + + + data + + + type パラメータで示された種類の詳細なデバッグデータ。 + + + + + + + + diff --git a/translation.xml b/translation.xml index 30983a198a..e324970f31 100644 --- a/translation.xml +++ b/translation.xml @@ -32,6 +32,7 @@ +