(PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8)
curl_setopt — Устанавливает параметр для cURL-передачи
Устанавливает параметр для указанного дескриптора сеанса cURL.
handle
Дескриптор cURL, полученный из curl_init().
option
Параметр CURLOPT_XXX
, который нужно установить.
value
Значение для параметра option
.
Значение параметра value
должно быть логическим (bool)
для следующих значений параметра option
:
Параметр | Устанавливаемое значение value |
Примечания |
---|---|---|
CURLOPT_AUTOREFERER |
true для автоматической установки поля Referer:
в запросах, перенаправленных заголовком Location: .
|
|
CURLOPT_COOKIESESSION |
true для указания текущему сеансу начать новую «сессию» cookies. Это заставит
модуль libcurl проигнорировать все «сессионные» cookies из предыдущего сеанса,
которые он собирается загрузить. По умолчанию модуль libcurl всегда
сохраняет и загружает все cookies, вне зависимости от того, являются ли они
«сессионными» или нет. «Сессионные» cookies — это cookies без срока истечения,
которые должны существовать только для текущей «сессии».
|
|
CURLOPT_CERTINFO |
true для вывода информации о сертификате SSL в поток STDERR
при безопасных соединениях.
|
Добавлена в cURL 7.19.1.
Для корректной работы требует
включённой опции CURLOPT_VERBOSE .
|
CURLOPT_CONNECT_ONLY |
true сообщает библиотеке, чтобы она провела необходимые аутентификацию прокси
и настройку соединения, но не передавала данные. Эта опция реализована для
HTTP, SMTP и POP3.
|
Добавлена в 7.15.2. |
CURLOPT_CRLF |
true для преобразования концов строк Unix в CRLF.
|
|
CURLOPT_DISALLOW_USERNAME_IN_URL |
true для запрета URL-адресов, содержащих имя пользователя.
Имена пользователей по умолчанию разрешены (0).
|
Добавлено в cURL 7.61.0. Доступно с PHP 7.3.0. |
CURLOPT_DNS_SHUFFLE_ADDRESSES |
true для перемешивания порядка всех возвращённых адресов так, чтобы они выбирались
в случайном порядке, когда имя разрешено и возвращено более одного IP-адреса.
Поэтому IPv4 может быть выбран до IPv6 или наоборот.
|
Добавлено в cURL 7.60.0. Доступно с PHP 7.3.0. |
CURLOPT_HAPROXYPROTOCOL |
true для отправки заголовка протокола HAProxy PROXY v1 в начале соединения.
Действие по умолчанию — не отправлять заголовок.
|
Добавлено в cURL 7.60.0. Доступно с PHP 7.3.0. |
CURLOPT_SSH_COMPRESSION |
true для включения встроенного сжатия SSH. Это запрос, а указание;
сервер может это и не выполнить.
|
Добавлено в cURL 7.56.0. Доступно с PHP 7.3.0. |
CURLOPT_DNS_USE_GLOBAL_CACHE |
true для разрешения имён через глобальный кеш DNS. Этот параметр
не потокобезопасный. Он условно включён по умолчанию, если PHP собран
для потоконебезопасной работы (CLI, FCGI, Apache2-Prefork, и т. д.).
|
|
CURLOPT_FAILONERROR |
true для подробного отчёта при неудаче, если полученный HTTP-код
больше или равен 400. Поведение по умолчанию возвращает страницу
как обычно, игнорируя код.
|
|
CURLOPT_SSL_FALSESTART |
true для разрешения ложного старта TLS.
|
Добавлено cURL 7.42.0. Доступно с PHP 7.0.7. |
CURLOPT_FILETIME |
true для попытки получения даты модификации удалённого документа.
Дату получают, вызывая функцию curl_getinfo()
с опцией CURLINFO_FILETIME .
|
|
CURLOPT_FOLLOWLOCATION |
true для следования любому заголовку
«Location: » , отправленному сервером
в ответе.
Смотрите также CURLOPT_MAXREDIRS .
|
|
CURLOPT_FORBID_REUSE |
true , чтобы соединение принудительно закрывалось,
когда обработка завершилась, и не попадало в пул
открытых соединений — было недоступно для повторной передачи.
|
|
CURLOPT_FRESH_CONNECT |
true для принудительной установки нового соединения
вместо закешированного.
|
|
CURLOPT_FTP_USE_EPRT |
true для отправки команд EPRT (и LPRT) при активных FTP-загрузках.
Указывают false , чтобы отключить команды EPRT и LPRT
и использовать только команду PORT.
|
|
CURLOPT_FTP_USE_EPSV |
true для первоначальной пробы команды EPSV при FTP-передачах.
Если команда не удалась, будет произведён обратный
откат к PASV. Установите в false для отключения EPSV.
|
|
CURLOPT_FTP_CREATE_MISSING_DIRS |
true для создания отсутствующих директорий, если FTP-операция
обнаруживает несуществующий путь.
|
|
CURLOPT_FTPAPPEND |
true для записи в конец удалённого файла, вместо перезаписывания.
|
|
CURLOPT_TCP_NODELAY |
true для отключения алгоритма Нейгла, который пытается
уменьшить количество мелких пакетов в сети.
|
Доступна для версий собранных с libcurl 7.11.2 или новее. |
CURLOPT_FTPASCII |
Псевдоним CURLOPT_TRANSFERTEXT .
Используйте его вместо этого.
|
|
CURLOPT_FTPLISTONLY |
true для возврата только списка имён из FTP-директории.
|
|
CURLOPT_HEADER |
true для включения заголовков в вывод.
|
|
CURLINFO_HEADER_OUT |
true для отслеживания строки запроса дескриптора.
|
Префикс CURLINFO_
использован преднамеренно.
|
CURLOPT_HTTP09_ALLOWED |
Определяет, разрешить ли ответы HTTP/0.9. С версии модуля libcurl 7.66.0 значение по умолчанию — false ;
ранее по умолчанию было логическое true .
|
Доступна с PHP 7.3.15 и 7.4.3, соответственно, если собрано с модулем libcurl >= 7.64.0 |
CURLOPT_HTTPGET |
true для сброса метода HTTP-запроса на метод GET.
Поскольку метод GET установлен по умолчанию, этот параметр необходим только
в случае, если метод запроса был ранее изменён.
|
|
CURLOPT_HTTPPROXYTUNNEL |
true для туннелирования через указанный HTTP-прокси.
|
|
CURLOPT_HTTP_CONTENT_DECODING |
false для получения необработанного тела HTTP-ответа.
|
Доступно, если собран с libcurl >= 7.16.2. |
CURLOPT_KEEP_SENDING_ON_ERROR |
true для продолжения посылать тело запроса, если возвращаемый HTTP-код
равен или больше 300. Действие по умолчанию — остановить отправку
и закрыть поток или соединение. Подходит для ручной аутентификации NTLM.
Большинству приложений эта опция не нужна.
|
Доступно с PHP 7.3.0, если собран с libcurl >= 7.51.0. |
CURLOPT_MUTE |
true для полного отключения сообщений функций cURL.
|
Удалена в cURL 7.15.5 (Можно использовать опцию CURLOPT_RETURNTRANSFER) |
CURLOPT_NETRC |
true для считывания файла ~/.netrc,
чтобы найти логин и пароль для удалённого сайта, с которым
устанавливается соединение.
|
|
CURLOPT_NOBODY |
true для исключения тела ответа из вывода.
Метод запроса устанавливается в HEAD. Смена этого параметра в false
не меняет его обратно в GET.
|
|
CURLOPT_NOPROGRESS |
|
|
CURLOPT_NOSIGNAL |
true для игнорирования любой функции cURL, посылающей сигналы
PHP процессу. Этот параметр включён по умолчанию в многопоточных
SAPI для корректной работы параметров времени ожидания.
|
Добавлен в cURL 7.10. |
CURLOPT_PATH_AS_IS |
true для игнорирования последовательностей с двумя точками.
|
Добавлено в cURL 7.42.0. Доступно с PHP 7.0.7. |
CURLOPT_PIPEWAIT |
true для ожидания конвейера/мультиплексирования.
|
Добавлено в cURL 7.43.0. Доступно с PHP 7.0.7. |
CURLOPT_POST |
true для отправки запроса обычным HTTP-методом POST. Метод POST
использует обычный тип тела запроса application/x-www-form-urlencoded ,
который большей частью встречается при отправке HTML-форм.
|
|
CURLOPT_PUT |
true для загрузки файла HTTP-методом PUT. Загружаемый файл должен быть
задан с помощью параметров CURLOPT_INFILE
и CURLOPT_INFILESIZE .
|
|
CURLOPT_RETURNTRANSFER |
true для возврата результата передачи в качестве строки из
curl_exec() вместо прямого вывода в браузер.
|
|
CURLOPT_SASL_IR |
true для разрешения отправки инициирующего ответа в первом пакете.
|
Добавлено в cURL 7.31.10. Доступно с PHP 7.0.7. |
CURLOPT_SSL_ENABLE_ALPN |
false для отключения ALPN в SSL-рукопожатии (если на бэкенде SSL-модуль
libcurl собран с её поддержкой), это можно использовать при соединении http2.
|
Добавлено в cURL 7.36.0. Доступно с PHP 7.0.7. |
CURLOPT_SSL_ENABLE_NPN |
false для отключения ALPN в SSL-рукопожатии (если на бэкенде SSL
libcurl собран с её поддержкой), это можно использовать при соединении http2.
|
Добавлено в cURL 7.36.0. Доступно с PHP 7.0.7. |
CURLOPT_SSL_VERIFYPEER |
false для остановки cURL от проверки сертификата узла сети.
Альтернативные сертификаты для проверки могут быть указаны
в параметре CURLOPT_CAINFO или директории с
сертификатами, указываемой параметром CURLOPT_CAPATH .
|
Начиная с версии cURL 7.10 значение по умолчанию равно true .
Дистрибутив по умолчанию устанавливается с версией cURL 7.10.
|
CURLOPT_SSL_VERIFYSTATUS |
true для проверки статуса сертификата.
|
Добавлено в cURL 7.41.0. Доступно с PHP 7.0.7. |
CURLOPT_PROXY_SSL_VERIFYPEER |
false для остановки cURL от проверки сертификата пира.
Альтернативные сертификаты для проверки могут быть
указаны с помощью параметра CURLOPT_CAINFO ,
а каталог сертификатов может быть указан с помощью
параметра CURLOPT_CAPATH .
Если установлено значение false, проверка сертификата однорангового узла завершается успешно несмотря ни на что.
|
true по умолчанию. Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0.
|
CURLOPT_SAFE_UPLOAD |
Всегда true , это отключает поддержку префикса @ для загрузки файлов
в CURLOPT_POSTFIELDS и означает, что значения,
начинающиеся с @ , могут быть безопасно переданы в качестве полей.
Вместо этого для загрузки файлов можно использовать объект CURLFile.
|
|
CURLOPT_SUPPRESS_CONNECT_HEADERS |
true для подавления заголовков ответов прокси-сервера CONNECT из пользовательских callback-функции
CURLOPT_HEADERFUNCTION и CURLOPT_WRITEFUNCTION ,
когда установлена опция CURLOPT_HTTPPROXYTUNNEL и выполняется запрос CONNECT.
|
Добавлено в cURL 7.54.0. Доступно с PHP 7.3.0. |
CURLOPT_TCP_FASTOPEN |
true для разрешения TCP Fast Open.
|
Добавлено в cURL 7.49.0. Доступно с PHP 7.0.7. |
CURLOPT_TFTP_NO_OPTIONS |
true для запрета отправки запросов TFTP-опций.
|
Добавлено в cURL 7.48.0. Доступно с PHP 7.0.7. |
CURLOPT_TRANSFERTEXT |
true для установки ASCII-режима при FTP-передачах. При передаче данных по протоколу LDAP
данные возвращаются простым текстом вместо HTML. В системах Windows
это не установит поток STDOUT в бинарный режим.
|
|
CURLOPT_UNRESTRICTED_AUTH |
true для продолжения отправки логина и пароля при перенаправлениях
(используя CURLOPT_FOLLOWLOCATION ),
даже при изменении имени хоста.
|
|
CURLOPT_UPLOAD |
true для подготовки к загрузке файла на сервер.
|
|
CURLOPT_VERBOSE |
true для вывода дополнительной информации. Записывает вывод в
поток STDERR , или файл, указанный параметром
CURLOPT_STDERR .
|
Для следующих значений параметра option
,
параметр value
должен быть типа
int:
Параметр | Устанавливаемое значение value |
Замечания | |
---|---|---|---|
CURLOPT_BUFFERSIZE |
Размер буфера (в байтах), который будет выделяться при каждом чтении. Однако нет гарантии, что запрос на получение такого размера будет исполнен. | Добавлен в версии cURL 7.10. | |
CURLOPT_CONNECTTIMEOUT |
Количество секунд ожидания, отведённых на попытку соединения. Установка значения 0 приведёт к неограниченному ожиданию. | ||
CURLOPT_CONNECTTIMEOUT_MS |
Количество миллисекунд ожидания, отведённых на попытку соединения. Установка значения 0 приведёт к неограниченному ожиданию. Если библиотека libcurl скомпилирована со стандартным системным преобразователем имён, то эта часть соединения по-прежнему будет использовать полносекундное разрешение интервалов с минимальным допустимым временем ожидания в 1 секунду. | Добавлен в версии cURL 7.16.2. | |
CURLOPT_DNS_CACHE_TIMEOUT |
Количество секунд, в течение которых в памяти хранятся DNS-записи. По умолчанию этот параметр равен 120 (2 минуты). | ||
CURLOPT_EXPECT_100_TIMEOUT_MS |
Время ожидания ответов с заголовком Expect: 100-continue в миллисекундах.
По умолчанию — 1000 миллисекунд.
|
Добавлено в cURL 7.36.0. Доступно с PHP 7.0.7. | |
CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS |
Преимущество протокола ipv6 для алгоритма Happy Eyeballs. Алгоритм Happy Eyeballs пытается подключиться как к адресам IPv4, так и к адресам IPv6 для хостов с двойным стеком, отдавая преимущество сначала IPv6 на время ожидания в миллисекундах. Значение по умолчанию — CURL_HET_DEFAULT, которое составляет 200 миллисекунд. | Добавлено в cURL 7.59.0. Доступно с PHP 7.3.0. | |
CURLOPT_FTPSSLAUTH |
Метод FTP-аутентификации (в активном режиме):
CURLFTPAUTH_SSL (сначала проверяется SSL),
CURLFTPAUTH_TLS (сначала проверяется TLS) или
CURLFTPAUTH_DEFAULT (cURL решает сама).
|
Добавлен в cURL 7.12.2. | |
CURLOPT_HEADEROPT |
Что делать с заголовками. Одна из следующих опций:
CURLHEADER_UNIFIED : заголовки, указанные в
опции CURLOPT_HTTPHEADER будут использованы в запросах
к серверам и прокси. Если разрешена эта опция,
опция CURLOPT_PROXYHEADER не будет иметь эффекта.
CURLHEADER_SEPARATE : заголовки
CURLOPT_HTTPHEADER будут отсылаться только
на сервер, но не на прокси. На прокси заголовки должны посылаться
CURLOPT_PROXYHEADER . Обратите внимание, что
если запросы типа non-CONNECT будут слаться на прокси, то libcurl будет
посылать как серверные, так и прокси заголовки. Если же происходит
CONNECT, libcurl пошлёт на прокси только заголовки CURLOPT_PROXYHEADER ,
а потом заголовки CURLOPT_HTTPHEADER только на сервер.
По умолчанию CURLHEADER_SEPARATE , начиная с cURL
7.42.1, и CURLHEADER_UNIFIED до него.
|
Добавлено в cURL 7.37.0. Доступно с PHP 7.0.7. | |
CURLOPT_HTTP_VERSION |
CURL_HTTP_VERSION_NONE (значение по умолчанию; CURL сам решает, какую версию использовать),
CURL_HTTP_VERSION_1_0 (принудительно соединяться по протоколу HTTP/1.0),
CURL_HTTP_VERSION_1_1 (принудительно соединяться по протоколу HTTP/1.1),
CURL_HTTP_VERSION_2_0 (попытаться соединиться по протоколу HTTP/2.0),
CURL_HTTP_VERSION_2 (псевдоним CURL_HTTP_VERSION_2_0 ),
CURL_HTTP_VERSION_2TLS (попытаться соединиться только по протоколу HTTP/2.0 через TLS (HTTPS))
или CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE (выполнять HTTP-запросы без TLS по протоколу HTTP/2.0 без возврата к HTTP/1.1).
|
||
CURLOPT_HTTPAUTH |
Методы HTTP-аутентификации. Параметры:
Можно использовать побитовый оператор
|
||
CURLOPT_INFILESIZE |
Ожидаемый размер файла в байтах при загрузке файла на удалённый сервер.
Учтите, что использование этой опции не остановит дальнейшую посылку данных,
превышающих это значение, так как посылаемые данные зависят от результата
CURLOPT_READFUNCTION .
|
||
CURLOPT_LOW_SPEED_LIMIT |
Верхний порог скорости передачи данных, в байтах в секунду. Проверка происходит
в течение CURLOPT_LOW_SPEED_TIME секунд, после чего
PHP считает передачу слишком медленной и прерывает её.
|
||
CURLOPT_LOW_SPEED_TIME |
Максимальное количество секунд, в течение которых скорость передачи
не должна превышать значение опции CURLOPT_LOW_SPEED_LIMIT , иначе
PHP пометит передачу как слишком медленную и прекратит её.
|
||
CURLOPT_MAIL_RCPT_ALLLOWFAILS |
Разрешить ошибки для команды RCPT TO для некоторых получателей. | При отправке данных нескольким получателям cURL прерывает SMTP-диалог, если хотя бы для одного из получателей на команду RCPT TO была получена ошибка. Этот параметр сообщает cURL, чтобы он игнорировал ошибки и продолжал с оставшимися доступными получателями. Если все получатели вызвали ошибку команды RCPT TO и этот флаг установлен, cURL прервёт SMTP-диалог и вернёт ошибку, полученную от последней команды RCPT TO. | |
CURLOPT_MAXAGE_CONN |
Максимальное время ожидания, в течение которого разрешено повторно
использовать существующее соединение.
По умолчанию максимальный срок установлен на 118 секунд.
|
||
CURLOPT_MAXFILESIZE_LARGE |
Максимальный разрешённый размер файла в байтах для скачивания. Если размер запрошенного файла
окажется больше этого значения,
передача не начнётся и вернётся значение константы CURLE_FILESIZE_EXCEEDED .
Размер файла не всегда известен до начала скачивания, и на скачивание таких таких файлов
этот параметр не повлияет, даже если
в итоге размер файла превышает установленный предел.
|
||
CURLOPT_MAXLIFETIME_CONN |
Максимальное время в секундах с момента установления соединения, в течение которого разрешено рассматривать существующее соединение для повторной передачи. Если соединение будет найдено в кеше, который старше этого значения, оно не будет рассмотрено для повторной передачи и будет закрыто как только все незавершенные передачи будут завершены. По умолчанию — 0 секунд, что означает, что параметр выключен и все соединения доступны для повторной передачи. | ||
CURLOPT_MAXCONNECTS |
Максимальное количество постоянных соединений. При достижении лимита, самое старое соединение в кеше закрывается, чтобы предотвратить увеличение числа открытых соединений. | ||
CURLOPT_MAXREDIRS |
Максимальное количество принимаемых перенаправлений. Используйте этот параметр
вместе с параметром CURLOPT_FOLLOWLOCATION .
Значение по умолчанию 20 установлено для предотвращения бесконечных перенаправлений.
Значение -1 разрешает бесконечные перенаправления, а 0
отклоняет все перенаправления.
|
||
CURLOPT_PORT |
Альтернативный порт соединения. | ||
CURLOPT_POSTREDIR |
Битовая маска, содержащая 1 (301 Moved Permanently), 2 (302 Found)
и 4 (303 See Other), чтобы задавать должен ли метод HTTP POST обрабатываться при
включённой опции CURLOPT_FOLLOWLOCATION , если
произошёл указанный тип перенаправления.
|
Добавлено в cURL 7.19.1. | |
CURLOPT_PROTOCOLS |
Битовая маска из значений
Корректные значения протоколов:
|
Добавлен в cURL 7.19.4. | |
CURLOPT_PROXYAUTH |
Методы авторизации HTTP, которые будут использованы при соединении с прокси-сервером.
Для этой опции устанавливают те же самые битовые маски, которые были описаны в параметре
CURLOPT_HTTPAUTH . Для авторизации прокси
поддерживаются только значения CURLAUTH_BASIC
и CURLAUTH_NTLM .
|
Добавлен в версии cURL 7.10.7. | |
CURLOPT_PROXYPORT |
Номер порта прокси-сервера, к которому осуществляется
соединение. Этот номер также может быть установлен
с помощью параметра CURLOPT_PROXY .
|
||
CURLOPT_PROXYTYPE |
Либо CURLPROXY_HTTP (по умолчанию), либо
CURLPROXY_SOCKS4 ,
CURLPROXY_SOCKS5 ,
CURLPROXY_SOCKS4A или
CURLPROXY_SOCKS5_HOSTNAME .
|
Добавлен в версии cURL 7.10. | |
CURLOPT_REDIR_PROTOCOLS |
Битовая маска из значений CURLPROTO_* .
Эта битовая маска ограничивает протоколы,
которые библиотека libcurl будет использовать при перенаправлении (при включённом параметре
CURLOPT_FOLLOWLOCATION ).
Этим можно ограничить набор протоколов при перенаправлениях для
отдельных передач. По умолчанию libcurl поддерживает все протоколы, кроме
FILE и SCP. В версиях до 7.19.4 перенаправление
использовалось для всех протоколов без исключения.
Смотрите также описание параметра CURLOPT_PROTOCOLS
для списка констант со значениями протоколов.
|
Добавлен в версии cURL 7.19.4. | |
CURLOPT_RESUME_FROM |
Смещение в байтах для возобновления передачи. | ||
CURLOPT_SOCKS5_AUTH |
Метод аутентификации SOCKS5, который нужно использовать. Варианты:
Побитовый оператор
По умолчанию |
Доступно с 7.3.0 и curl >= 7.55.0. | |
CURLOPT_SSL_OPTIONS |
Устанавливает опции поведения SSL. Битовая маска из следующих констант:
CURLSSLOPT_ALLOW_BEAST : не пытаться найти обходной
путь для изъяна в безопасности протоколов SSL3 и TLS1.0.
CURLSSLOPT_NO_REVOKE : отключить проверку
на предмет того, отозван ли сертификат, для тех SSL-бэкендов,
где такое поведение присутствует.
CURLSSLOPT_AUTO_CLIENT_CERT : автоматически
находить и использовать сертификат клиента для аутентификации
по запросу сервера.
Эта опция поддерживается только
модулем поставщика служб безопасности Schannel (собственный SSL-модуль Windows).
CURLSSLOPT_NATIVE_CA : использовать собственное
хранилище доверенных центров сертификации (Certificate authority, CA)
операционной системы для проверки сертификата.
Работает только в Windows с установленной сборкой библиотеки OpenSSL.
Это экспериментальная опция и её поведение может измениться в будущем.
CURLSSLOPT_NO_PARTIALCHAIN : не принимать цепочки
«частных» сертификатов, что cURL в других случаях делает по умолчанию.
Эта опция поддерживается только для библиотеки OpenSSL
и приведёт к ошибке проверки сертификата, если цепочка заканчивается
на промежуточном, а не на корневом сертификате.
CURLSSLOPT_REVOKE_BEST_EFFORT : игнорировать проверку на предмет того,
отозван ли сертификат, в случае отсутствия или отключения точек распространения для тех SSL-бэкендов,
где такое поведение присутствует.
Эта опция поддерживается только модулем поставщика служб безопасности Schannel (собственный SSL-модуль Windows).
Если указана вместе с опцией CURLSSLOPT_NO_REVOKE ,
последняя будет в приоритете.
|
Добавлено в cURL 7.25.0. Доступно с PHP 7.0.7. | |
CURLOPT_SSL_VERIFYHOST |
Указывают значение 2 , чтобы убедиться, что поле общего имени
или поле альтернативного имени субъекта в сертификате узла SSL соответствует указанному имени хоста.
Значение 0 указывают, чтобы не проверять имена.
Значение 1 не следует использовать.
В боевом окружении значение этого параметра должно
быть 2 (установлено по умолчанию).
|
Поддержка значения 1 убрана в cURL 7.28.1
|
|
CURLOPT_SSLVERSION |
Одна из констант CURL_SSLVERSION_DEFAULT (0),
CURL_SSLVERSION_TLSv1 (1),
CURL_SSLVERSION_SSLv2 (2),
CURL_SSLVERSION_SSLv3 (3),
CURL_SSLVERSION_TLSv1_0 (4),
CURL_SSLVERSION_TLSv1_1 (5)
CURL_SSLVERSION_TLSv1_2 (6) или
CURL_SSLVERSION_TLSv1_3 (7).
Максимальная версия TLS может быть установлена с помощью одной из констант CURL_SSLVERSION_MAX_* .
Также можно ИЛИ одну из констант CURL_SSLVERSION_* с одной из констант CURL_SSLVERSION_MAX_* .
CURL_SSLVERSION_MAX_DEFAULT (максимальная версия, поддерживаемая библиотекой),
CURL_SSLVERSION_MAX_TLSv1_0 ,
CURL_SSLVERSION_MAX_TLSv1_1 ,
CURL_SSLVERSION_MAX_TLSv1_2 , or
CURL_SSLVERSION_MAX_TLSv1_3 .
|
||
CURLOPT_PROXY_SSL_OPTIONS |
Задайте параметры поведения SSL-прокси, которые являются битовой маской любой из следующих констант:
CURLSSLOPT_ALLOW_BEAST : не пытаться использовать
обходные пути для устранения уязвимости в протоколах SSL3 и TLS1.0.
CURLSSLOPT_NO_REVOKE : отключить проверку
на предмет того, отозван ли сертификат, для тех бэкендов SSL,
где такое поведение присутствует. (curl >= 7.44.0)
CURLSSLOPT_NO_PARTIALCHAIN : не принимать «частичные»
цепочки сертификатов, что в противном случае делается по умолчанию. (curl >= 7.68.0)
|
Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. | |
CURLOPT_PROXY_SSL_VERIFYHOST |
Значение 2 устанавливают для проверки в полях
имени сертификата прокси-сервера HTTPS по отношению к имени прокси-сервера.
Когда установлено значение 0 , соединение успешно выполняется
независимо от имён, указанных в сертификате.
Используйте эту способность с осторожностью!
1 рассматривается как опция отладки в curl 7.28.0 и более ранних версиях.
С версии curl 7.28.1 до 7.65.3 возвращено значение CURLE_BAD_FUNCTION_ARGUMENT .
Начиная с curl 7.66.0 и далее значения 1 и 2 обрабатываются как одно и то же значение.
В производственной среде значение этой опции должно быть 2 (значение по умолчанию).
|
Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. | |
CURLOPT_PROXY_SSLVERSION |
Одна из CURL_SSLVERSION_DEFAULT ,
CURL_SSLVERSION_TLSv1 ,
CURL_SSLVERSION_TLSv1_0 ,
CURL_SSLVERSION_TLSv1_1 ,
CURL_SSLVERSION_TLSv1_2 ,
CURL_SSLVERSION_TLSv1_3 ,
CURL_SSLVERSION_MAX_DEFAULT ,
CURL_SSLVERSION_MAX_TLSv1_0 ,
CURL_SSLVERSION_MAX_TLSv1_1 ,
CURL_SSLVERSION_MAX_TLSv1_2 ,
CURL_SSLVERSION_MAX_TLSv1_3 или
CURL_SSLVERSION_SSLv3 .
|
Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. | |
CURLOPT_STREAM_WEIGHT |
Установить вес цифрового потока (число между 1 и 256). | Добавлено в cURL 7.46.0. Доступно с PHP 7.0.7. | |
CURLOPT_TCP_KEEPALIVE |
Если установлено значение 1 , будут отправлены пробные сообщения поддержки активности TCP. Задержку и
частоту этих проб можно контролировать с помощью параметров CURLOPT_TCP_KEEPIDLE и
CURLOPT_TCP_KEEPINTVL , если операционная система их
поддерживает. Если установлено значение 0 (по умолчанию), пробные сообщения проверки активности отключены.
|
Добавлено в cURL 7.25.0. | |
CURLOPT_TCP_KEEPIDLE |
Устанавливает задержку в секундах, в течение которой операционная система будет ждать, пока соединение находится в режиме ожидания,
перед отправкой проб проверки активности,
если включено CURLOPT_TCP_KEEPALIVE . Не все операционные системы поддерживают эту опцию.
По умолчанию установлено значение 60 .
|
Добавлено в cURL 7.25.0. | |
CURLOPT_TCP_KEEPINTVL |
Устанавливает интервал в секундах, в течение которого операционная система будет ожидать между
отправкой проб проверки активности, если включено CURLOPT_TCP_KEEPALIVE .
Не все операционные системы поддерживают эту опцию.
По умолчанию установлено значение 60 .
|
Добавлено в cURL 7.25.0. | |
CURLOPT_TIMECONDITION |
Способ трактовки параметра CURLOPT_TIMEVALUE .
Значение CURL_TIMECOND_IFMODSINCE указывают для
возвращения страницы, только если она была изменена со времени,
указанного в параметре CURLOPT_TIMEVALUE .
Если страница не была изменена, вернётся заголовок
"304 Not Modified" , подразумевая, что
параметр CURLOPT_HEADER установлен в true .
Значение CURL_TIMECOND_IFUNMODSINCE указывают для обратного эффекта.
Значение CURL_TIMECOND_NONE — чтобы игнорировать
опцию CURLOPT_TIMEVALUE и всегда возвращать страницу.
По умолчанию установлено значение CURL_TIMECOND_NONE .
|
До cURL 7.46.0 значение по умолчанию было CURL_TIMECOND_IFMODSINCE .
|
|
CURLOPT_TIMEOUT |
Максимально позволенное количество секунд для выполнения cURL-функций. | ||
CURLOPT_TIMEOUT_MS |
Максимально разрешённое количество миллисекунд для выполнения cURL-функций. Если библиотека libcurl собрана с обычным системным распознавателем имён, то этот промежуток соединения по-прежнему будет использовать полносекундное разрешение интервалов ожидания с минимально разрешённым временем ожидания в одну секунду. | Добавлен в версии cURL 7.16.2. | |
CURLOPT_TIMEVALUE |
Количество секунд начиная с 1 января 1970 года. Это время
будет использовано параметром
CURLOPT_TIMECONDITION .
|
||
CURLOPT_TIMEVALUE_LARGE |
Время в секундах с 1 января 1970 года. Время будет использовано CURLOPT_TIMECONDITION . По умолчанию ноль.
Разница между этой опцией и CURLOPT_TIMEVALUE
заключается в типе аргумента. В системах, где 'long' имеет размер всего 32 бита,
этот параметр нужно указывать для установки дат после 2038 года.
|
Добавлено в cURL 7.59.0. Доступно с PHP 7.3.0. | |
CURLOPT_UPKEEP_INTERVAL_MS |
В некоторые протоколы встроен механизмы «поддержания соединения». Эти механизмы
обычно отправляют небольшой объем трафика через существующие соединения,
чтобы держать их открытыми. Эта опция определяет интервал, в течение которого будет поддерживаться соединение.
Действующий и единственный протокол с механизмом поддержания соединения — это HTTP/2. Когда
интервал поддержания соединения истекает, протокол HTTP/2 отправляет в соединение кадр PING.
Значение по умолчанию – 60 секунд.
|
||
CURLOPT_UPLOAD_BUFFERSIZE |
Предпочтительный размер буфера загрузки cURL в байтах. Размер буфера загрузки по умолчанию — 64 килобайта. Максимально можно установить 2 мегабайта. Минимально — 16 килобайтов. | ||
CURLOPT_MAX_RECV_SPEED_LARGE |
Если скорость скачки превысит это значение (указанное в байтах в секунду) в среднем в течение всей передачи, то скачка будет приостановлена для поддержания средней скорости меньше либо равной данному параметру. По умолчанию скорость не ограничивается. | Добавлен в версии cURL 7.15.5. | |
CURLOPT_MAX_SEND_SPEED_LARGE |
Если загрузка на сервер превысит это значение (указанное в байтах в секунду) в среднем в течение всей передачи, то загрузка будет приостановлена для поддержания средней скорости меньше либо равной данному параметру. По умолчанию скорость не ограничивается. | Добавлен в версии cURL 7.15.5. | |
CURLOPT_SSH_AUTH_TYPES |
Битовая маска, состоящая из одной или более констант:
CURLSSH_AUTH_PUBLICKEY ,
CURLSSH_AUTH_PASSWORD ,
CURLSSH_AUTH_HOST ,
CURLSSH_AUTH_KEYBOARD . Установите
CURLSSH_AUTH_ANY , чтобы libcurl сам выбрал одну из них.
|
Добавлено в cURL 7.16.1. | |
CURLOPT_IPRESOLVE |
Разрешает приложению выбрать, какой вид IP-адресов использовать, когда разрешаются имена хостов.
Это интересно только для имён хостов, которые разрешаются
несколько IP-адресов. Возможные значения:
CURL_IPRESOLVE_WHATEVER ,
CURL_IPRESOLVE_V4 ,
CURL_IPRESOLVE_V6 и по умолчанию —
CURL_IPRESOLVE_WHATEVER .
|
Добавлено в cURL 7.10.8. | |
CURLOPT_FTP_FILEMETHOD |
Сообщить дескриптору cURL, какой метод доступа к файлу на сервере FTP использовать. Возможные значения:
CURLFTPMETHOD_DEFAULT ,
CURLFTPMETHOD_MULTICWD ,
CURLFTPMETHOD_NOCWD
и CURLFTPMETHOD_SINGLECWD .
|
Добавлено в cURL 7.15.1. |
Для следующих значений параметра option
,
параметр value
должен быть типа
string:
Параметр | Устанавливаемое значение value |
Замечания |
---|---|---|
CURLOPT_ABSTRACT_UNIX_SOCKET |
Разрешает использовать абстрактный доменный сокет Unix вместо
установления TCP-соединения с хостом и устанавливает путь
к указанной строке (string). Эта опция использует ту же семантику,
что и CURLOPT_UNIX_SOCKET_PATH . Эти два параметра
совместно используют одно и то же хранилище, поэтому для каждого дескриптора можно установить только
один из них.
|
Доступно с PHP 7.3.0 и cURL 7.53.0 |
CURLOPT_ALTSVC |
Передать дескриптору cURL имя файла, который будет работать
в качестве файла Alt-Svc-кеша для чтения существующих кешированных данных
и, возможно, также записи их обратно после передачи,
за исключением случаев, когда для опции CURLOPT_ALTSVC_CTRL
установлено значение CURLALTSVC_READONLYFILE .
|
|
CURLOPT_ALTSVC_CTRL |
Заполните битовую маску правильными значениями, чтобы проинструктировать дескриптор cURL,
как обрабатывать кеш Alt-Svc при передаче.
Дескриптор cURL принимает заголовки Alt-Svc только через HTTPS.
Запрос к альтернативному источнику выполнится
только если источник правильно настроен на обмен данными по протоколу HTTPS.
Установка любого бита включит движок alt-svc. Доступны следующие опции:
CURLALTSVC_H1 ,
CURLALTSVC_H2 ,
CURLALTSVC_H3
и CURLALTSVC_READONLYFILE .
|
|
CURLOPT_AWS_SIGV4 |
Обеспечивает аутентификацию подписи в заголовке HTTP(S) по протоколу AWS V4.
Эта опция переопределит любые другие типы аутентификации, которые были
установлены опцией |
|
CURLOPT_CAINFO |
Имя файла, содержащего один или более сертификатов, с которыми
будут сверяться узлы. Этот параметр будет полезен только
при совместной работе с CURLOPT_SSL_VERIFYPEER .
|
Может потребоваться абсолютный путь. |
CURLOPT_CAINFO_BLOB |
Название PEM-файла, содержащего один или несколько сертификатов для проверки
узла. Эта опция переопределяет опцию CURLOPT_CAINFO .
|
Доступна начиная с PHP 8.2.0 и cURL 7.77.0. |
CURLOPT_CAPATH |
Директория, содержащая несколько CA-сертификатов.
Используйте этот параметр совместно с
CURLOPT_SSL_VERIFYPEER .
|
|
CURLOPT_COOKIE |
Содержимое заголовка "Cookie: " ,
который будет передан в HTTP-запросе.
Обратите внимание, что несколько cookies разделяются
точкой с запятой с последующим пробелом
(например, "fruit=apple; colour=red ")
|
|
CURLOPT_COOKIEFILE |
Имя файла, содержащего cookies. Данный файл должен быть в формате Netscape или просто заголовками HTTP, записанными в файл. Если в качестве имени файла передана пустая строка, то cookies сохраняться не будут, но их обработка всё ещё будет включена. | |
CURLOPT_COOKIEJAR |
Имя файла, в котором будут сохранены все внутренние cookies текущей передачи после закрытия дескриптора, например, после вызова curl_close. | |
CURLOPT_COOKIELIST |
Строка cookie (т.е. одна строка в формате Netscape/Mozilla или обычный заголовок
Set-Cookie в стиле HTTP) добавляет этот единственный cookie во внутреннее хранилище cookie.
"ALL" удаляет все файлы cookie, хранящиеся в памяти.
"SESS" удаляет все файлы cookie сессии, хранящиеся в памяти.
"FLUSH" записывает все известные файлы cookie в файл, указанный в CURLOPT_COOKIEJAR .
"RELOAD" загружает все файлы cookie из файлов, указанных в CURLOPT_COOKIEFILE .
|
Доступно с cURL 7.14.1. |
CURLOPT_CUSTOMREQUEST |
Пользовательский метод запроса, который будет использован вместо
|
|
CURLOPT_DEFAULT_PROTOCOL |
Протокол по умолчанию, если он отсутствует в схеме URL. |
Добавлено в cURL 7.45.0. Доступно с PHP 7.0.7. |
CURLOPT_DNS_INTERFACE |
Устанавливает имя сетевого интерфейса, к которому привязан DNS. Это должно быть имя интерфейса, а не адрес. |
Добавлено в cURL 7.33.0. Доступно с PHP 7.0.7. |
CURLOPT_DNS_LOCAL_IP4 |
Установить локальный IPv4-адрес, по которому доступен DNS. Адрес должен быть представлен в виде строки, содержащий одно число. |
Добавлено в cURL 7.33.0. Доступно с PHP 7.0.7. |
CURLOPT_DNS_LOCAL_IP6 |
Установить локальный IPv6-адрес, по которому доступен DNS. Адрес должен быть представлен в виде строки, содержащий одно число. |
Добавлено в cURL 7.33.0. Доступно с PHP 7.0.7. |
CURLOPT_EGDSOCKET |
Наподобие CURLOPT_RANDOM_FILE , за исключением
того, что имя файла устанавливается в сокет Entropy
Gathering Daemon.
|
|
CURLOPT_ENCODING |
Содержимое заголовка "Accept-Encoding: " .
Это позволяет декодировать запрос. Поддерживаемыми
кодировками являются "identity" ,
"deflate" и "gzip" .
Если передана пустая строка, "" ,
посылается заголовок, содержащий все поддерживаемые
типы кодировок.
|
Добавлен в версии cURL 7.10. |
CURLOPT_FTPPORT |
Значение, которое будет использовано для определения IP-адреса для команды "PORT" FTP-протокола. Команда "PORT" сообщает серверу, с каким IP-адресом он должен устанавливать соединение. Это может быть IP-адрес, имя хоста, имя сетевого интерфейса (под Unix) или просто '-', чтобы использовать системный IP-адреса по умолчанию. | |
CURLOPT_HSTS |
Имя файла кеша HSTS (HTTP Strict Transport Security). |
|
CURLOPT_HSTS_CTRL |
Управляет поведением механизма HSTS (HTTP Strict Transport Security).
Заполните битовую маску правильным набором значений, чтобы проинструктировать
дескриптор cURL, как обрабатывать хосты HSTS при передаче с этим дескриптором.
Константа |
|
CURLOPT_INTERFACE |
Имя исходящего сетевого интерфейса, который надо использовать. Может быть именем интерфейса, IP-адресом или именем хоста. | |
CURLOPT_KEYPASSWD |
Пароль для закрытого ключа опции CURLOPT_SSLKEY
или CURLOPT_SSH_PRIVATE_KEYFILE .
|
Добавлено в cURL 7.16.1. |
CURLOPT_KRB4LEVEL |
Уровень безопасности KRB4 (Kerberos 4). Любое из следующих
значений (в порядке от слабого к самому сильному) корректно:
"clear" ,
"safe" ,
"confidential" ,
"private". .
Если указанная строка отличается от данных значений,
будет использовано значение "private" .
Установка этого параметра в null полностью отключит
безопасность KRB4. На данный момент безопасность KRB4
работает только с FTP-транзакциями.
|
|
CURLOPT_LOGIN_OPTIONS |
Опция может быть задана для установки характерных для протокола настроек логина,
например, механизма аутентификации "AUTH=NTLM" или "AUTH=*",
и должна быть задана совместно с опцией CURLOPT_USERNAME .
|
Добавлено в cURL 7.34.0. Доступно с PHP 7.0.7. |
CURLOPT_PINNEDPUBLICKEY |
Устанавливает зафиксированный открытый ключ. Строка должны содержать имя файла, в котором лежит ваш зафиксированный открытый ключ. Ожидается формат файла "PEM" или "DEX". Строка также может быть числом в формате base64, закодированным sha256 с префиксом "sha256//" и разделённая точкой с запятой ";". | Добавлено в cURL 7.39.0. Доступно с PHP 7.0.7. |
CURLOPT_POSTFIELDS |
Все данные, передаваемые в HTTP POST-запросе.
Этот параметр может быть передан
как в качестве URL-кодированной строки, наподобие
«para1=val1¶2=val2&... », так и
в виде массива, ключами которого будут имена полей, а значениями —
их содержимое.
Если параметр value — массив,
заголовок Content-Type будет установлен в
значение multipart/form-data .
Файлы можно отправить в виде переданного в параметр value массива,
содержащего объекты класса CURLFile или CURLStringFile.
|
|
CURLOPT_PRIVATE |
Любые данные, которые должны быть связаны с этим дескриптором cURL.
Эти данные можно выбрать подзапросом опции
CURLINFO_PRIVATE функции
curl_getinfo(). Дескриптор cURL ничего не делает с этими данными.
При работе с множественным дескриптором cURL эти закрытые данные обычно
выступают в роли уникального ключа для определения дескриптора cURL.
|
Добавлено в cURL 7.10.3. |
CURLOPT_PRE_PROXY |
Задайте строку (string), содержащую имя хоста или
IP-адрес, который будет использован в качестве прокси-сервера, к которому подключается curl, прежде чем
он подключится к прокси-серверу HTTP(S), указанному в
опции CURLOPT_PROXY для предстоящего запроса.
Предварительный прокси-сервер может быть только SOCKS-прокси, и перед ним должен стоять префикс
[scheme]:// , чтобы указать, какой тип socks использовать.
Числовой адрес IPv6 должен быть написан в [скобках].
Установка препрокси в пустую строку явно отключает использование препрокси.
Чтобы указать номер порта в этой строке, добавьте :[port]
в конец имени хоста. Номер порта прокси-сервера может быть дополнительно
указан в опции CURLOPT_PROXYPORT .
Если порт для прокси не указан, по умолчанию будет установлен порт 1080.
|
Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. |
CURLOPT_PROXY |
HTTP-прокси, через который будут направляться запросы. | |
CURLOPT_PROXY_SERVICE_NAME |
Имя сервиса аутентификации прокси. | Добавлено в cURL 7.43.0 для HTTP-прокси и в cURL 7.49.0 для SOCKS5-прокси. Доступно, начиная с PHP 7.0.7. |
CURLOPT_PROXY_CAINFO |
Путь к прокси-серверу центра сертификации. Задайте путь в виде строки (string) с именем файла, содержащего один или несколько сертификатов для проверки прокси с помощью HTTPS. Этот параметр предназначен для подключения к прокси-серверу HTTPS, а не к серверу HTTPS. По умолчанию задан системный путь, где предполагается хранить пакет cacert libcurl. | Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. |
CURLOPT_PROXY_CAINFO_BLOB |
Имя файла PEM, содержащего один или несколько сертификатов для проверки HTTPS-прокси. Эту опция касается подключения к HTTPS-прокси, а не к HTTPS-серверу. По умолчанию установлен системный путь, по которому предполагается хранить набор сертификатов удостоверяющих центров модуля libcurl. | Доступно начиная с PHP 8.2.0 и libcurl >= cURL 7.77.0. |
CURLOPT_PROXY_CAPATH |
Каталог, содержащий несколько сертификатов центра сертификации для проверки прокси HTTPS. | Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. |
CURLOPT_PROXY_CRLFILE |
Задайте имя файла с помощью конкатенации CRL (списка отзыва сертификатов) в формате PEM для использования при проверке сертификата, которая происходит во время обмена SSL. | Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. |
CURLOPT_PROXY_KEYPASSWD |
Строка, которая будет использована как пароль
для закрытого ключа опции CURLOPT_PROXY_SSLKEY .
Пароль для загрузки сертификата не нужен, но нужен пароль для загрузки закрытого ключа.
Этот параметр нужен для подключения к прокси-серверу HTTPS, а не к серверу HTTPS.
|
Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. |
CURLOPT_PROXY_PINNEDPUBLICKEY |
Установите закреплённый открытый ключ для HTTPS-прокси. Строка может быть именем файла вашего закреплённого открытого ключа. Ожидаемый формат файла: "PEM" или "DER". Строка также может быть любым количеством закодированных в base64 хешей sha256, которым предшествует "sha256//" и разделяются ";" | Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. |
CURLOPT_PROXY_SSLCERT |
Имя файла клиентского сертификата для подключения к прокси HTTPS.
Формат по умолчанию — "P12" в Secure Transport и "PEM" в других движках;
его можно изменить с помощью CURLOPT_PROXY_SSLCERTTYPE .
С NSS или Secure Transport это также может быть псевдоним сертификата,
с которым надо пройти аутентификацию, так как он назван в базе данных безопасности.
Если надо использовать файл из текущего каталога, к нему добавляют
префикс "./", чтобы избежать путаницы с псевдонимом.
|
Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. |
CURLOPT_PROXY_SSLCERTTYPE |
Формат сертификата клиента, который будет использован при подключении к HTTPS-прокси. Поддерживаемые форматы: "PEM" и "DER", за исключением Secure Transport. OpenSSL (версии 0.9.3 и новее) и Secure Transport (в iOS 5 или новее или OS X 10.7 или новее) также поддерживают "P12" для файлов в кодировке PKCS#12. По умолчанию "PEM". | Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. |
CURLOPT_PROXY_SSL_CIPHER_LIST |
Список шифров, которые будут использованы для подключения к прокси HTTPS. Список должен быть синтаксически правильным, он состоит из одной или нескольких строк шифров, разделённых двоеточиями. Запятые или пробелы также являются допустимыми разделителями, но обычно качестве операторов используются двоеточия, !, - и +. | Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. |
CURLOPT_PROXY_TLS13_CIPHERS |
Список наборов шифров, которые будут использованы для подключения TLS 1.3 к прокси.
Список должен быть синтаксически правильным, он состоит из одной или нескольких
строк набора шифров, разделённых двоеточиями. Эту опцию используют
только тогда, когда curl собран для работы с OpenSSL 1.1.1 или новее.
Если выбран другой бэкенд SSL, можно попытаться установить
наборы шифров TLS 1.3 через параметр CURLOPT_PROXY_SSL_CIPHER_LIST .
|
Доступно с PHP 7.3.0 и libcurl >= cURL 7.61.0. Доступно при сборке с OpenSSL >= 1.1.1. |
CURLOPT_PROXY_SSLKEY |
Имя файла личного ключа, который будет использован для подключения к прокси HTTPS.
Формат по умолчанию — "PEM", и его можно изменить через опцию
CURLOPT_PROXY_SSLKEYTYPE .
(Только для iOS и Mac OS X). Этот параметр игнорируется, если curl был создан для Secure Transport.
|
Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. Доступно, если включён встроенный TLS. |
CURLOPT_PROXY_SSLKEYTYPE |
Формат вашего закрытого ключа. Поддерживаемые форматы: "PEM", "DER" и "ENG". | Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. |
CURLOPT_PROXY_TLSAUTH_PASSWORD |
Пароль для метода аутентификации TLS, который задан
в параметре CURLOPT_PROXY_TLSAUTH_TYPE . Требует, чтобы
также был установлен параметр CURLOPT_PROXY_TLSAUTH_USERNAME .
|
Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. |
CURLOPT_PROXY_TLSAUTH_TYPE |
Метод аутентификации TLS для соединения HTTPS. Поддерживаемый метод — "SRP".
|
Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. |
CURLOPT_PROXY_TLSAUTH_USERNAME |
Имя пользователя, которое будет использовано для метода аутентификации TLS прокси-сервера HTTPS, указанного в параметре
CURLOPT_PROXY_TLSAUTH_TYPE . Требует, чтобы параметр
CURLOPT_PROXY_TLSAUTH_PASSWORD также был установлен.
|
Доступно с PHP 7.3.0 и libcurl >= cURL 7.52.0. |
CURLOPT_PROXYUSERPWD |
Логин и пароль, записанные в виде
"[username]:[password]" , которые будут использованы при
соединении через прокси.
|
|
CURLOPT_RANDOM_FILE |
Имя файла для инициализации генератора случайных чисел для SSL. | |
CURLOPT_RANGE |
Диапазон данных, которые нужно загрузить, в формате
"X-Y" , причём либо X, либо Y могут быть
опущены. Протокол HTTP также поддерживает передачу
нескольких диапазонов, разделённых запятыми, они задаются
в формате "X-Y,N-M" .
|
|
CURLOPT_REFERER |
Содержимое заголовка "Referer: " , который будет
использован в HTTP-запросе.
|
|
CURLOPT_SASL_AUTHZID |
Идентификатор авторизации (authzid) для передачи. Эту опцию можно применять только для механизма аутентификации PLAIN SASL, где это необязательно. Если идентификатор авторизации не задан, только идентификатор аутентификации (authcid), как определено в имени пользователя, будет отправлен на сервер (вместе с паролем). Сервер получит идентификатор авторизации (authzid) из идентификатора аутентификации (authcid), если идентификатор авторизации не был указан, и затем он будет использовать внутренне. | |
CURLOPT_SERVICE_NAME |
Имя сервиса аутентификации. | Добавлено в cURL 7.43.0. доступно с PHP 7.0.7. |
CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 |
Строка, содержащая 32 шестнадцатеричных цифры. Строка должна являться контрольной суммой по алгоритму MD5 открытого ключа удалённого компьютера и libcurl будет сбрасывать соединение к удалённому хосту до тех пор, пока контрольная сумма не будет соответствовать публичному ключу. Эта опция предназначена только для передачи данных с помощью SCP и SFTP. | Добавлено в cURL 7.17.1. |
CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256 |
Закодированный в Base64 по алгоритму SHA256 хеш публичного ключа удалённого хоста. Передача завершится ошибкой, если заданный хеш не соответствует хешу удалённого хоста. | |
CURLOPT_SSH_PUBLIC_KEYFILE |
Имя файла для вашего публичного ключа. Если не задано, то libcurl использует по умолчанию файл $HOME/.ssh/id_dsa.pub, если переменная окружения HOME установлена и файл "id_dsa.pub" в текущей директории, если переменная HOME не установлена. | Добавлено в cURL 7.16.1. |
CURLOPT_SSH_PRIVATE_KEYFILE |
Имя файла для вашего приватного ключа. Если не задано, то libcurl использует по
умолчанию файл $HOME/.ssh/id_dsa, если переменная окружения HOME установлена и
файл "id_dsa" в текущей директории, если переменная HOME не установлена.
Если файл защищён паролем, установите пароль с помощью
CURLOPT_KEYPASSWD .
|
Добавлено в cURL 7.16.1. |
CURLOPT_SSL_CIPHER_LIST |
Список шифров для SSL-передач. Например,
RC4-SHA и TLSv1 —
корректные списки шифров.
|
|
CURLOPT_SSL_EC_CURVES |
Разделённый двоеточием список основанных на эллиптических кривых алгоритмов.
Например,
X25519:P-521 — это допустимый список из двух эллиптических кривых.
Эта опция определят клиентские алгоритмы обмена во время SSL-рукопожатия,
если дескриптор cURL на SSL-бэкенде собран с поддержкой этой опции.
|
|
CURLOPT_SSLCERT |
Имя файла с корректно отформатированным PEM-сертификатом. | |
CURLOPT_SSLCERTPASSWD |
Пароль для сертификата опции CURLOPT_SSLCERT .
|
|
CURLOPT_SSLCERTTYPE |
Формат сертификата. Поддерживаются форматы
"PEM" (по умолчанию), "DER"
и "ENG" .
Начиная с OpenSSL 0.9.3, "P12" (для файлов, закодированных в PKCS#12)
|
Добавлен в версии cURL 7.9.3. |
CURLOPT_SSLENGINE |
Идентификатор механизма шифрования для закрытого ключа SSL,
указанного в параметре CURLOPT_SSLKEY .
|
|
CURLOPT_SSLENGINE_DEFAULT |
Идентификатор механизма шифрования для асимметричных операций шифрования. | |
CURLOPT_SSLKEY |
Имя файла с закрытым ключом SSL. | |
CURLOPT_SSLKEYPASSWD |
Тайный пароль для закрытого
ключа SSL, указанного параметром
|
|
CURLOPT_SSLKEYTYPE |
Тип закрытого ключа SSL, указанного в параметре
CURLOPT_SSLKEY . Поддерживаются следующие
типы ключей:
"PEM" (по умолчанию), "DER"
и "ENG" .
|
|
CURLOPT_TLS13_CIPHERS |
Список комплектов шифров для соединения TLS 1.3. Список должен быть
синтаксически правильным, он состоит из одной или нескольких строк набора шифров, разделённых двоеточиями.
Эту опцию используют только тогда, когда curl собран для работы OpenSSL 1.1.1 или новее.
Если выбран другой бэкенд SSL, можно попробовать установить
наборы шифров TLS 1.3 через параметр CURLOPT_SSL_CIPHER_LIST .
|
Доступен с PHP 7.3.0 и libcurl >= cURL 7.61.0. Доступен, когда собран с библиотекой OpenSSL >= 1.1.1. |
CURLOPT_UNIX_SOCKET_PATH |
Разрешает использовать доменные сокеты UNIX в качестве конечной точки для соединения и устанавливает путь к ним равным заданной строке (string). | Добавлено в cURL 7.40.0. Доступно с PHP 7.0.7. |
CURLOPT_URL |
Загружаемый URL. Данный параметр может быть также установлен при инициализации сеанса с помощью curl_init(). | |
CURLOPT_USERAGENT |
Содержимое заголовка "User-Agent: " , посылаемого
в HTTP-запросе.
|
|
CURLOPT_USERNAME |
Имя пользователя для аутентификации. | Добавлено в cURL 7.19.1. |
CURLOPT_PASSWORD |
Пароль для аутентификации. | Добавлено в cURL 7.19.1. |
CURLOPT_USERPWD |
Логин и пароль для соединения, указанные в формате
"[username]:[password]" .
|
|
CURLOPT_XOAUTH2_BEARER |
Задаёт токен доступа OAuth 2.0. | Добавлено в cURL 7.33.0. Доступно с PHP 7.0.7. |
Для следующих значений параметра option
,
параметр value
должен быть массивом:
Параметр | Устанавливаемое значение value |
Замечания |
---|---|---|
CURLOPT_CONNECT_TO |
Соединяться с хостом на установленном порте, игнорируя URL.
Принимает массив строк формата
HOST:PORT:CONNECT-TO-HOST:CONNECT-TO-PORT .
|
Добавлено в cURL 7.49.0. Доступно с PHP 7.0.7. |
CURLOPT_HTTP200ALIASES |
Массив HTTP 200 ответов, которые будут трактоваться корректными ответами, а не ошибочными. | Добавлен в cURL 7.10.3. |
CURLOPT_HTTPHEADER |
Массив устанавливаемых HTTP-заголовков в формате
array('Content-type: text/plain', 'Content-length: 100')
|
|
CURLOPT_POSTQUOTE |
Массив FTP-команд, выполняемых на сервере, после выполнения FTP-запроса. | |
CURLOPT_PROXYHEADER |
Массив пользовательских HTTP-заголовков для отправки на прокси | Добавлено в cURL 7.37.0. Доступно с PHP 7.0.7. |
CURLOPT_QUOTE |
Массив FTP-команд, выполняемых на сервере перед выполнением FTP-запроса. | |
CURLOPT_RESOLVE |
Предоставляет адрес для определённой пары хоста и порта. Массив,
содержащий строки, состоящие из имени хоста, порта и IP-адреса,
разделённых двоеточием. Пример:
array("example.com:80:127.0.0.1")
|
Добавлено в cURL 7.21.3. |
Для следующих значений параметра option
параметр value
должен быть потоковым
дескриптором (возвращаемым, например, функцией fopen()):
Параметр | Устанавливаемое значение value |
---|---|
CURLOPT_FILE |
Файл, в который будет записан результат передачи. По умолчанию
запись идёт в поток вывода STDOUT (окно браузера).
|
CURLOPT_INFILE |
Файл, из которого должно идти чтение данных, при загрузке на сервер. |
CURLOPT_STDERR |
Альтернативный файл для вывода ошибок, который будет использован вместо потока ошибок
STDERR .
|
CURLOPT_WRITEHEADER |
Файл, в который будут записаны заголовки текущей операции. |
Для следующих значений параметра option
,
параметр value
должен быть правильным именем функции
или замыканием:
Параметр | Устанавливаемое значение value |
Примечания | |
---|---|---|---|
CURLOPT_HEADERFUNCTION |
Callback-функция принимает два параметра. Первым параметром является дескриптор cURL, вторым параметром является строка с записываемыми заголовками. Заголовки должны быть записаны с помощью данной callback-функции. Должна возвратить количество записанных байт. | ||
CURLOPT_PASSWDFUNCTION |
Callback-функция принимает три параметра. Первым параметром идёт дескриптор cURL, вторым параметром — строка с запросом пароля, третьим — максимальная длина пароля. Должна возвратить строку, содержащую пароль. | Удалено, начиная с PHP 7.3.0. | |
CURLOPT_PROGRESSFUNCTION |
Callback-функция принимает пять параметров. Первый является дескриптором cURL, второй — общим количеством байт, которое ожидается загрузить с сервера, третий — количеством уже загруженных байтов, четвёртый — общим количеством байтов, для которых ожидается отправка на сервер, и пятый — количеством уже отправленных байтов.
Можно вернуть ненулевое значение, чтобы отменить передачу.
В этом случае будет выдана ошибка |
||
CURLOPT_READFUNCTION |
Callback-функция принимает три параметра.
Первым параметром является дескриптор cURL,
вторым параметром — ресурс потока, переданный
cURL через опцию CURLOPT_INFILE ,
а третьим — максимально разрешённое
количество данных для чтения.
Callback-функция должна возвратить строку с длиной,
не превышающей запрошенного количества данных, обычно
с помощью чтения из переданного потокового ресурса.
Должна возвратить пустую строку для сигнала о конце файла
EOF .
|
||
CURLOPT_WRITEFUNCTION |
Callback-функция принимает два параметра. Первым параметром является дескриптор cURL, а вторым — строка с записываемыми данными. Данные должны быть сохранены с помощью данной функции. Она должна возвратить точное количество записанных байт, иначе закачка будет прервана с ошибкой. | ||
CURLOPT_XFERINFOFUNCTION |
Callback-функция, принимающая два параметра.
Имеет схожее назначение с опцией CURLOPT_PROGRESSFUNCTION ,
но является более современным и предпочтительным вариантом от cURL.
|
Добавлена в версии 7.32.0. Доступна, начиная с PHP 8.2.0. |
Другие значения:
Параметр | Устанавливаемое значение value |
---|---|
CURLOPT_SHARE |
Результат выполнения функции curl_share_init(). Разрешает обработчику cURL использовать данные из общего обработчика. |
Возвращает true
в случае успешного выполнения или false
, если возникла ошибка.
Пример #1 Инициализация сеанса CURL и загрузка веб-страницы
<?php
// Создаём новый ресурс cURL
$ch = curl_init();
// Устанавливаем URL-адрес и другие параметры
curl_setopt($ch, CURLOPT_URL, "http://www.example.com/");
curl_setopt($ch, CURLOPT_HEADER, false);
// Захватываем страницу и передаём её браузеру
curl_exec($ch);
// Закрываем дескриптор cURL и освобождаем ресурсы системы
curl_close($ch);
?>
Замечание:
Передача массива в параметр
CURLOPT_POSTFIELDS
закодирует данные с типом multipart/form-data, тогда как передача URL-кодированной строки закодирует данные с типом application/x-www-form-urlencoded.