curl_setopt
(PHP 4 >= 4.0.2, PHP 5)
curl_setopt — Eine Option für einen cURL Transfer setzen
Beschreibung
Setzt eine Option für das angegeben cURL-Handle
Parameter-Liste
-
ch -
Ein von curl_init() zurückgegebenes cURL-Handle.
-
option -
Die zu setzende CURLOPT_XXX-Option
-
value -
Der Wert für
valuevaluesollte ein boolean für die folgenden Werte des Parametersoptionsein:Option Wert für valueAnmerkungen CURLOPT_AUTOREFERERTRUEum automatisch den Referer: in Abfragen zu setzen, die einem Redirect per Location: folgenCURLOPT_BINARYTRANSFERTRUEum die unbearbeiteten Daten zurüchzugeben wennCURLOPT_RETURNTRANSFERgesetzt ist.Ab PHP 5.1.3 hat diese Option keine Auswirkungen mehr: die unbearbeitenten Daten werden immer zurückgegeben, wenn CURLOPT_RETURNTRANSFERgesetzt ist.CURLOPT_COOKIESESSIONTRUEum diesen Request als neue "Cookie Session" zu behandeln. Somit wird libcurl alle cookies die geladen werden sollen ignorieren, sofern es sich um "Session Cookies" einer vorherigen Session handelt. Standardmässig lädt und speichert libcurl alle cookies, unabhängig davon, ob es "Session Cookies" sind. Bei "Session Cookies" handelt es sich um Cookies ohne Ablaufdatum, die nur für die aktuelle Session gültig sind.CURLOPT_CERTINFOTRUEum die SSL Zertifikatsinformation bei sicheren Übertragungen auf STDERR auszugeben.Hinzugefügt in cURL 7.19.1. Verfügbar seit PHP 5.3.2. Erfordert, dass CURLOPT_VERBOSEgesetzt ist, um zu wirken.CURLOPT_CONNECT_ONLYTRUEweist die Bibliothek an, die gesamte erforderlichen Proxy-Authentifizierung und den Verbindungsaufbau durchzuführen, aber keine Datenübertragung. Diese Option ist für HTTP, SMTP und POP3 implementiert.Hinzugefügt in 7.15.2. Verfügbar seit PHP 5.5.0. CURLOPT_CRLFTRUEum Unix-Zeilenumbrüche beim Transfer in CRLF-Zeilenumbrüche umzuwandeln.CURLOPT_DNS_USE_GLOBAL_CACHETRUEum den globalen DNS-Cache zu nutzen. Diese Option ist nicht thread-safe und standardmässig aktiviert.CURLOPT_FAILONERRORTRUEum PHP anzuweisen, bei Fehlern (HTTP-Code ist größer oder gleich 400) eine ausführliche Fehlermeldung zu liefern. Dieses Verhalten ist standardmässig aktiviert.CURLOPT_FILETIMETRUEum zu versuchen, das Änderungsdatum des serverseitigen Dokuments zu ermitteln. Der Wert kann über die Funktion curl_getinfo() unter Verwendung des ParametersCURLINFO_FILETIMEermittelt werden.CURLOPT_FOLLOWLOCATIONTRUEum jedem "Location: "-Header zu folgen, den der Server als Teil der HTTP-Header zurückgibt. Die Verarbeitung erfolgt rekursiv, PHP wird jedem "Location: "-Header folgen, sofern nichtCURLOPT_MAXREDIRSgesetzt ist.CURLOPT_FORBID_REUSETRUEum die Verbindung nach der Verarbeitung explizit zu schließen, so daß sie nicht wiederverwendet werden kann.CURLOPT_FRESH_CONNECTTRUEum den expliziten Aufbau einer neuen Verbindung zu erzwingen, anstatt auf eine gecachte zurückzugreifen.CURLOPT_FTP_USE_EPRTTRUE, um EPRT (und LPRT) für aktive FTP-Downloads zu nutzen. AufFALSEsetzen, um EPRT und LPRT zu deaktivieren und ausschließlich PORT zu nutzen.CURLOPT_FTP_USE_EPSVTRUEum vor dem Fallback auf PASV zunächst eine EPSV-Anweisung für einen FTP-Transfer auszuführen. AufFALSEsetzen, um EPSV zu deaktivieren.CURLOPT_FTP_CREATE_MISSING_DIRSTRUEum fehlende Verzeichnisse zu erzeugen, wenn eine FTP-Operation auf einen Pfad stößt, der zurzeit nicht existiert.CURLOPT_FTPAPPENDTRUEum Daten an die serverseitige Datei anzuhängen anstatt diese zu überschreiben.CURLOPT_TCP_NODELAYPass a long specifying whether the TCP_NODELAY option is to be set or cleared (1 = set, 0 = clear). The option is cleared by default. Verfügbar seit PHP 5.2.1 für Versionen, die mit libcurl 7.11.2 oder höher kompiliert wurden. CURLOPT_FTPASCIIEin Alias für CURLOPT_TRANSFERTEXT, das bevorzugt werden sollte.CURLOPT_FTPLISTONLYTRUEum nur die Namen in einem FTP-Verzeichnis aufzulisten.CURLOPT_HEADERTRUEum den Header in die Ausgabe aufzunehmen.CURLINFO_HEADER_OUTTRUEum den Request-String des Handles zu verfolgen.Verfügbar seit PHP 5.1.3. DasPrefix CURLINFO_ist beabsichtigt.CURLOPT_HTTPGETTRUEum die HTTP-Request-Methode auf GET zu setzen. Da dies die Standard-Methode ist sollte dies nur nach einem Wechsel der Request-Methode notwendig sein.CURLOPT_HTTPPROXYTUNNELTRUEum einen vorhandenen Proxy-Tunnel zu nutzenCURLOPT_MUTETRUEum jegliche Ausgabe der cURL-Funktionen zu unterbindenEntfernt in cURL 7.15.5 (statt dessen kann CURLOPT_RETURNTRANSFER verwendet werden) CURLOPT_NETRCTRUEum die lokale Datei ~/.netrc nach Benutzername/Passwort für die Authorisierung des Zugriffs zu durchsuchen.CURLOPT_NOBODYTRUEum den Body nicht in die Ausgabe aufzunehmen.CURLOPT_NOPROGRESSTRUEum die Fortschrittsanzeige für den Transfer auszublenden.Hinweis:
PHP setzt die Option automatisch auf
TRUE. Dies sollte ausschließlich für die Fehlersuche geändert werden.CURLOPT_NOSIGNALTRUEum jegliche cURL-Funktion zu ignorieren, die ein Signal an den PHP-Prozess sendet. In multi-threaded SAPIs ist diese Option standardmässig aktiviert, so daß Timeouts weiterhin abgefangen werden können.Hinzugefügt in cURL 7.10 und PHP 5.0.0. CURLOPT_POSTTRUEum einen HTTP-POST-Request abzusetzen. Dabei handelt es sich um das übliche application/x-www-form-urlencoded, wie es im Allgemeinen von HTML-Formularen erzeugt wird.CURLOPT_PUTTRUEum ein HTTP-PUT für eine Datei abzusetzen. Die fragliche Datei muss dabei über die KonstantenCURLOPT_INFILEundCURLOPT_INFILESIZEgesetzt werden.CURLOPT_RETURNTRANSFERTRUEum den Tranfer als String zurückzuliefern, anstatt ihn direkt auszugeben.CURLOPT_SAFE_UPLOADTRUEum die Unterstützung des @-Präfix zum Upload von Dateien inCURLOPT_POSTFIELDSzu deaktivieren, was bedeutet, dass Werte, die mit @ beginnen, sicher als Felder übergeben werden können. Statt dessen kann CURLFile für Uploads verwendet werden.Hinzugefügt in PHP 5.5.0 mit FALSEals Voreinstellung. PHP 5.6.0 ändert die Voreinstellung zuTRUE.CURLOPT_SSL_VERIFYPEERFALSEum die Überprüfung des Peerzertifikats seitens cURL zu unterdrücken. Alternative Zertifikate zur Überprüfung können mit der OptionCURLOPT_CAINFOangegeben werden oder ein Zertifikat-Verzeichniss kann mitCURLOPT_CAPATHausgewiesen werden.TRUEals Standard seit cURL 7.10.CURLOPT_TRANSFERTEXTTRUEum FTP-Transfers im ASCII-Modus durchzuführen. Für LDAP werden Daten in Klartext statt HTML übertragen. Unter Windows wird STDOUT nicht in den binären Modus gesetzt.CURLOPT_UNRESTRICTED_AUTHTRUEum beim Folgen eines Location: -Headers (sieheCURLOPT_FOLLOWLOCATION) weiterhin Benutzername und Passwort zu senden, sogar nach einem Wechsel des Hostnamens.CURLOPT_UPLOADTRUEum einen Upload vorzubereitenCURLOPT_VERBOSETRUEum ausführliche Informationen auszugeben, entweder nach STDERR oder in die mittels der OptionCURLOPT_STDERRgewählte Datei.Für die folgenden
option-Parameter solltevalueein Integer sein:Option Wert für valueAnmerkungen CURLOPT_BUFFERSIZEDie für jede Leseoperation zulässige Buffergröße. Es ist nicht garantiert, daß diese Einstellung genutzt wird. Hinzugefügt in cURL 7.10 and PHP 5.0.0. CURLOPT_CLOSEPOLICYEiner der CURLCLOSEPOLICY_*Werte.Hinweis:
Diese Option ist überholt, da sie niemals in cURL implementiert wurde, und niemals wirkte.
Entfernt in PHP 5.6.0. CURLOPT_CONNECTTIMEOUTDie Anzahl Sekunden, die der Verbindungsaufbau maximal dauern darf; 0 hebt die Begrenzung auf. CURLOPT_CONNECTTIMEOUT_MSDie Anzahl Millisekunden, die der Verbindungsaufbau maximal dauern darf; 0 hebt die Begrenzung auf. Wenn libcurl so kompiliert wurde, dass die standard System-Namensauflösung verwendet wird, wird dieser Teil der Verbindung dennoch die volle Sekunden-Auflösung für Timeouts mit einem minimalen Timeout von einer Sekunde verwenden. Hinzugefügt in cURL 7.16.2. Verfügbar seit PHP 5.2.3. CURLOPT_DNS_CACHE_TIMEOUTDie Dauer in Sekunden, die ein DNS-Eintrag im Speicher gehalten wird. Der Standard sind 120 Sekunden (2 Minuten). CURLOPT_FTPSSLAUTHDie FTP-Authentisierungsmethode (wenn aktiviert): CURLFTPAUTH_SSL (versuche zunächst SSL), CURLFTPAUTH_TLS (versuche zunächst TLS), oder CURLFTPAUTH_DEFAULT (lass cURL entscheiden). Hinzugefügt in cURL 7.12.2 und PHP 5.1.0. CURLOPT_HTTP_VERSIONCURL_HTTP_VERSION_NONE(Standard, lässt cURL entscheiden, welche Version genutzt werden soll),CURL_HTTP_VERSION_1_0(nutze HTTP/1.0), orCURL_HTTP_VERSION_1_1(nutze HTTP/1.1).CURLOPT_HTTPAUTHDie zu nutzende HTTP-Authentisierungsmethode; zur Verfügung stehen:
CURLAUTH_BASIC,CURLAUTH_DIGEST,CURLAUTH_GSSNEGOTIATE,CURLAUTH_NTLM,CURLAUTH_ANY, undCURLAUTH_ANYSAFE.Um mehrere Methoden zu kombinieren kann der Bit-|(oder)-Operator verwendet werden; in diesem Fall wird cURL in Abstimmung mit dem Server die günstigste Methode auswählen.
CURLAUTH_ANYist ein Alias für CURLAUTH_BASIC | CURLAUTH_DIGEST | CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM.CURLAUTH_ANYSAFEist ein Alias für CURLAUTH_DIGEST | CURLAUTH_GSSNEGOTIATE | CURLAUTH_NTLM.CURLOPT_INFILESIZEDie erwartete Dateigröße der hochzuladenden Datei in Bytes. Beachten Sie, dass die Verwendung dieser Option libcurl nicht daran hindern wird mehr Daten zu senden, da was genau gesendet wird von CURLOPT_READFUNCTIONabhängt.CURLOPT_LOW_SPEED_LIMITDie Transfergeschwindigkeit in Bytes pro Sekunde, die bei Unterschreitung in Kombination mit der Überschreitung von CURLOPT_LOW_SPEED_TIMESekunden bewirkt, dass der Transfer aufgrund der zu niedrigen Transferrate abgebrochen wird.CURLOPT_LOW_SPEED_TIMEDie Zeit in Sekunden, in der die Transferrate unter CURLOPT_LOW_SPEED_LIMITgedultet wird. Nach dieser Zeit wird die Transferrate als zu langsam angesehen und der Transfer wird beendet.CURLOPT_MAXCONNECTSDie maximal erlaubte Anzahl persistenter Verbindungen; bei Erreichen des Limits wird mittels CURLOPT_CLOSEPOLICYentschieden, welche Verbindung geschlossen wird.CURLOPT_MAXREDIRSDie maximal erlaubte Anzahl von HTTP-Weiterleitungen. Verwenden Sie diese Option zusammen mit CURLOPT_FOLLOWLOCATION.CURLOPT_PORTErlaubt das Setzen eines alternativen Ports für die Verbindung. CURLOPT_POSTREDIREine Bitmaske von 1 (301 Moved Permanently), 2 (302 Found) und 4 (303 See Other), ob die HTTP POST Methode beibehalten werden soll, wenn CURLOPT_FOLLOWLOCATIONgesetzt ist, und ein sepzifischer Typ von Weiterleitung auftritt.Hinzugefügt in cURL 7.19.1. Verfügbar seit PHP 5.3.2. CURLOPT_PROTOCOLSEine Bitmaske von
CURLPROTO_*-Werten. Mit dieser Einstellung lassen sich die Protokolle einschränken die libcurl für diesen Transfer nutzen darf. Damit wird es möglich ein libcurl mit einer Vielzahl an Protokollen zu benutzen, gleichzeitig aber lassen sich die für einen bestimmten Transfer zulässigen Protokolle beschränken. Standardmässig akzeptiert libcurl alle unterstützten Protokolle. Siehe auchCURLOPT_REDIR_PROTOCOLS.Zulässige Optionen:
CURLPROTO_HTTP,CURLPROTO_HTTPS,CURLPROTO_FTP,CURLPROTO_FTPS,CURLPROTO_SCP,CURLPROTO_SFTP,CURLPROTO_TELNET,CURLPROTO_LDAP,CURLPROTO_LDAPS,CURLPROTO_DICT,CURLPROTO_FILE,CURLPROTO_TFTP,CURLPROTO_ALLHinzugefügt in cURL 7.19.4. CURLOPT_PROXYAUTHDie HTTP-Authentisierungsmethode(n) für die Proxy-Verbindung. Nutzt die gleiche Bitmaske wie in CURLOPT_HTTPAUTHbeschrieben. NurCURLAUTH_BASICundCURLAUTH_NTLMsind momentan für Proxy-Verbindungen zulässig.Hinzugefügt in cURL 7.10.7 und PHP 5.1.0. CURLOPT_PROXYPORTDer Port, auf den die Proxy-Verbindung erfolgen soll; kann auch mittels CURLOPT_PROXYgesetzt werden.CURLOPT_PROXYTYPEEntweder CURLPROXY_HTTP(Standard) oderCURLPROXY_SOCKS5.Hinzugefügt in cURL 7.10. CURLOPT_REDIR_PROTOCOLSEine Bitmaske von CURLPROTO_*-Werten. Mit dieser Einstellung lassen sich die Protokolle einschränken die libcurl für diesen Transfer nutzen darf, wenn eine Weiterleitung stattfindet (setzt voraus daßCURLOPT_FOLLOWLOCATIONerlaubt ist). Damit wird es möglich ein libcurl mit einer Vielzahl an Protokollen zu benutzen, gleichzeitig aber lassen sich die für eine Weiterleitung zulässigen Protokolle beschränken. Standardmässig akzeptiert libcurl alle unterstützten Protokolle außer FILE und SCP. Siehe auchCURLOPT_PROTOCOLSfür weitere Informationen zu den Protokoll-Konstanten.Added in cURL 7.19.4. CURLOPT_RESUME_FROMDie Position in Bytes ab der ein Transfer fortgesetzt werden soll. CURLOPT_SSL_VERIFYHOST1 um auf die Existenz des Namens im Zertifikat zu prüfen, 2 stellt sicher, daß eine Übereinstimmung mit dem angegebenen Hostnamen vorliegt. In Produktsumgebungen sollte der Wert dieser Option 2 sein (Voreinstellung). Die Unterstützung für Wert 1 wurde in cURL 7.28.1 entfernt CURLOPT_SSLVERSIONEntweder 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) oderCURL_SSLVERSION_TLSv1_2(6).Hinweis:
Am besten ist es diese Option nicht zu setzen, und den Default zu verwenden. Die Werte 2 und 3 sind sehr gefährlich, angesichts der bekannten Sicherheitslücken in SSLv2 und SSLv3.
CURLOPT_TIMECONDITIONDieser Wert gibt an, wie CURLOPT_TIMEVALUEbehandelt werden soll. Mögliche Werte sindCURL_TIMECOND_IFMODSINCE(Standard) undCURL_TIMECOND_ISUNMODSINCE. Im ersten Fall wird geprüft, ob die Seite seitCURLOPT_TIMEVALUEgeändert wurde; andernfalls wird ein "304 Not Modified"-Header zurückgegeben (vorausgesetztCURLOPT_HEADERistTRUE).CURL_TIMECOND_ISUNMODSINCEbewirkt das gegenteilige Verhalten.CURLOPT_TIMEOUTDie maximale Ausführungszeit in Sekunden für cURL-Funktionen. CURLOPT_TIMEOUT_MSDie maximale Ausführungszeit in Millisekunden für cURL-Funktionen. Wenn libcurl so kompiliert wurde, dass die standard System-Namensauflösung verwendet wird, wird dieser Teil der Verbindung dennoch die volle Sekunden-Auflösung für Timeouts mit einem minimalen Timeout von einer Sekunde verwenden. Added in cURL 7.16.2. Available since PHP 5.2.3. CURLOPT_TIMEVALUEZeit in Sekunden seit dem 1. Januar 1970. Dieser Wert wird von CURLOPT_TIMECONDITIONgenutzt. Als Standard wirdCURL_TIMECOND_IFMODSINCEgenutzt.CURLOPT_MAX_RECV_SPEED_LARGEWenn ein Download diese Geschwindigkeit (gezählt in Bytes pro Sekunde) im Gesamtdurchschnitt während der Übertragung überschreitet, wird die Übertragung angehalten, um die durschnittliche Rate kleiner oder gleich dem Parameter-Wert zu halten. Voreinstellung ist unbegrenzte Geschwindigkeit. Hinzugefügt in cURL 7.15.5. Verfügbar seit PHP 5.4.0. CURLOPT_MAX_SEND_SPEED_LARGEWenn ein Upload diese Geschwindigkeit (gezählt in Bytes pro Sekunde) im Gesamtdurchschnitt während der Übertragung überschreitet, wird die Übertragung angehalten, um die durschnittliche Rate kleiner oder gleich dem Parameter-Wert zu halten. Voreinstellung ist unbegrenzte Geschwindigkeit. Hinzugefügt in cURL 7.15.5. Verfügbar seit PHP 5.4.0. CURLOPT_SSH_AUTH_TYPESEine Bitmaske bestehend aus einer oder mehreren von CURLSSH_AUTH_PUBLICKEY,CURLSSH_AUTH_PASSWORD,CURLSSH_AUTH_HOST,CURLSSH_AUTH_KEYBOARD.CURLSSH_AUTH_ANYlässt libcurl eine wählen.Hinzugefügt in cURL 7.16.1. CURLOPT_IPRESOLVEErlaubt einer Applikation auszuwählen, welche Art von IP Adressen verwendet werden, wenn Hostnamen aufgelöst werden. Dies ist nur interessant, wenn Hostnamen verwendet werden, die Adressen unter mehr als einer IP-Version auflösen; mögliche Werte sind CURL_IPRESOLVE_WHATEVER,CURL_IPRESOLVE_V4,CURL_IPRESOLVE_V6; Voreinstellung istCURL_IPRESOLVE_WHATEVER.Hinzugefügt in cURL 7.10.8. Für die folgenden
option-Parameter solltevalueein String sein:Option Wert für valueAnmerkungen CURLOPT_CAINFODer Name einer Datei, die ein oder mehrere Zerifikate enthält, gegen die der Peer geprüft wird. Macht nur Sinn in Verbindung mit CURLOPT_SSL_VERIFYPEER.Erfodert einen absoluten Pfad. CURLOPT_CAPATHEin Verzeichnis, das mehrere CA-Zertifikate enthält. Diese Option sollte In Kombination mit CURLOPT_SSL_VERIFYPEERgenutzt werden.CURLOPT_COOKIEDer Inhalt des im HTTP-Request zu setzenden "Cookie: "-Headers Beachten Sie daß mehrere Cookies durch ein Semikolon gefolgt von einem Leerzeichen getrennt werden (z.B. "fruit=apple; colour=red") CURLOPT_COOKIEFILEDer Name einer Datei, die Cookiedaten enthält. Diese Datei kann im Netscape-Format sein oder HTTP-geformte Header enthalten. Wenn der Name eine leere Zeichenkette ist, werden keine Cookies geladen, aber die Cookie-Behandlung ist dennoch aktiviert. CURLOPT_COOKIEJARDer Name einer Datei in der alle internen Cookies beim Schließen des Handles gespeichert werden, z.B. nach einem Aufruf von curl_close. CURLOPT_CUSTOMREQUESTEine benutzerdefinierte Request-Methode, die anstelle von GET oder HEAD für den HTTP-Request benutzt werden soll. Dies ist nützlich bei DELETE oder anderen unüblichen Requests. Zulässige Werte sind GET, POST, CONNECT etc. Vollständige HTTP-Requests wie GET /index.html HTTP/1.0\r\n\r\n sind unzulässig!
Hinweis:
Führen Sie diese Anfragen nicht durch ohne sicherzugehen, daß Ihr Server die betreffenden Kommandos unterstützt.
CURLOPT_EGDSOCKETAnalog CURLOPT_RANDOM_FILE, hier wird der Dateiname eines Entropy Gathering Daemon Socket erwartet.CURLOPT_ENCODINGDer Inhalt des "Accept-Encoding: "-Headers. Damit wird das Dekodieren der Serverantwort aktiviert. Unterstützte Kodierungen sind identity, deflate und gzip. Wird ein leerer String "" gesetzt wird ein Header mit allen unterstützten Kodierungen gesetzt. Hinzugefügt in cURL 7.10. CURLOPT_FTPPORTEin String, der genutzt wird, um die IP-Adresse zu erlangen, die von der FTP-PORT-Anweisung genutzt wird. Die PORT-Anweisung teilt dem entfernten Server mit, zu der angegebenen IP-Adresse zu verbinden. Der String kann eine einfache IP-Addresse, ein Hostname, der Name eines Netzwerkinterfaces (unter Unix) oder nur '-' sein, um die vordefinierte IP-Addresse (des Systems) zu nutzen. CURLOPT_INTERFACEDer Name des zu nutzenden Netzwerkinterfaces für ausgehende Daten. Statt des Namens des Interfaces kann auch eine IP-Adresse oder ein Hostname übergeben werden. CURLOPT_KEYPASSWDDas erforderliche Passwort, um die privaten CURLOPT_SSLKEYoderCURLOPT_SSH_PRIVATE_KEYFILESchlüssel zu verwenden.Hinzugefügt in cURL 7.16.1. CURLOPT_KRB4LEVELDie KRB4 (Kerberos 4) Sicherheitsstufe. Folgende Werte (von niedriger zu höherer Stufe) sind gültig: clear, safe, confidential, private. Sollte der String keinen dieser Werte enthalten dann wird die höchste Stufe genutzt, d.h private. Sollte diese Option mit dem Wert NULL besetzt werden, wird KRB4 Security deaktiviert. Bislang wird KRB4 nur unter Verwendung des FTP unterstützt. CURLOPT_POSTFIELDSDie in einem HTTP-POST-Request zu nutzenden Daten. Um eine Datei zu posten stellen Sie dem Dateinamen @ voran; bitte geben Sie den vollen Pfad zur Datei an. Der Dateityp kann explizit dadurch angegeben werden, dass dem Dateinamen der Type im Format ';type=mimetype' nachgestellt wird. Als Wert für diesen Parameter kann entweder ein URL-kodierter String übergeben werden wie z.B. 'para1=val1¶2=val2&...' oder ein Array, wobei die Feldnamen als Schlüssel und die Felddaten als Wert verwendet werden. Wird ein Array für valuedann wird der Content-Type-Header auf multipart/form-data gesetzt. Beginnend mit PHP 5.2.0 mussvalueein Array sein, wenn Dateien mit dem @-Präfix an diese Option übergeben werden Beginned mit PHP 5.5.0 gilt das @-Präfix als veraltet, und Dateien können mit CURLFile gesendet werden. Das @-Präfix kann deaktiviert werden, um die sichere Übergabe von Werten, die mit @ beginnen, zu gewährleisten, indemCURLOPT_SAFE_UPLOADaufTRUEgesetzt wird.CURLOPT_PROXYDer HTTP-Proxy, durch den Requests getunnelt werden sollen. CURLOPT_PROXYUSERPWDBenutzername und Passwort in der Form "[benutzername]:[passwort]" für die Proxy-Verbindung. CURLOPT_RANDOM_FILEEin Dateiname der zur Initialisierung des Zufallsgenerators für SSL benutzt wird. CURLOPT_RANGEBereiche an Daten, die empfangen werden sollen. Das Format sollte "X-Y" sein, wobei X oder Y optional sind. HTTP-Transfers unterstützen auch mehrere Komma-getrennte Intervalle im Format "X-Y,N-M". CURLOPT_REFERERDer Inhalt des "Referer: "-Headers CURLOPT_SSH_HOST_PUBLIC_KEY_MD5Eine Zeichenkette, die 32 hexadezimale Ziffern enthält. Die Zeichenkette sollte die MD5 Prüfsumme des öffentlichen Schlüssels des Remote-Hosts sein. libcurl wird die Verbindung zum Host zurückweisen, falls die Prüfsummen nicht übereinstimmen. Diese Option gilt nur für SCP und SFTP Übertragungen. Hinzugefügt in cURL 7.17.1. CURLOPT_SSH_PUBLIC_KEYFILEDer Dateiname des öffentlichen Schlüssels. Wenn nicht gesetzt, nimmt libcurl $HOME/.ssh/id_dsa.pub an, falls die HOME Umgebungsvariable gesetzt ist, und andernfalls "id_dsa.pub" im aktuellen Verzeichnis. Hinzugefügt in cURL 7.16.1. CURLOPT_SSH_PRIVATE_KEYFILEDer Dateiname des privaten Schlüssels. Wenn nicht gesetzt, nimmt libcurl $HOME/.ssh/id_dsa an, falls die HOME Umgebungsvariable gesetzt ist, und andernfalls "id_dsa" im aktuellen Verzeichnis. Wenn die Datei passwort geschützt ist, muss das Passwort mit CURLOPT_KEYPASSWDbestimmt werden.Hinzugefügt in cURL 7.16.1. CURLOPT_SSL_CIPHER_LISTEine Liste der für SSL zulässigen Chiffren. RC4-SHA und TLSv1 sind zulässig. CURLOPT_SSLCERTDer Name einer Datei die ein Zertifikat im PEM-Format enthält. CURLOPT_SSLCERTPASSWDDas Passwort für das CURLOPT_SSLCERT-Zertifikat.CURLOPT_SSLCERTTYPEDas Format des Zertifikats. Unterstützt werden PEM (Standard), DER und ENG. Hinzugefügt in cURL 7.9.3. CURLOPT_SSLENGINEDer Bezeichner für die Crypto Engine des privaten SSL-Schlüssels, der in CURLOPT_SSLKEYdefiniert ist.CURLOPT_SSLENGINE_DEFAULTDer Bezeichner für die Crypto-Engine für asymmetrische kryptographische Operationen. CURLOPT_SSLKEYDer Name einer Datei, die einen privaten SSL-Schlüssel enthält. CURLOPT_SSLKEYPASSWDDas geheime Passwort das für den in
CURLOPT_SSLKEYdefinierten privaten SSL-Schlüssel.Hinweis:
Da diese Option sensible Daten enthält sollte das PHP-Script in einer sicheren Umgebung liegen.
CURLOPT_SSLKEYTYPEDer Typ des in CURLOPT_SSLKEYdefinierten privaten SSL-Schlüssels. Unterstützte Schlüssel-Typen sind PEM (Standard), DER und ENG.CURLOPT_URLDer abzurufende URL; kann auch beim initialisieren der Session mittels curl_init() gesetzt werden. CURLOPT_USERAGENTDer Wert des "User-Agent: "-Headers für den HTTP-Request CURLOPT_USERPWDBenutzername und Passwort im Format "[benutzername]:[passwort]" Für die folgenden
option-Parameter solltevalueein Array sein:Option Wert für valueAnmerkungen CURLOPT_HTTP200ALIASESEin Array von HTTP-200-Status die als gültige Antoworten und nicht als Fehler behandelt werden. Hinzugefügt in cURL 7.10.3. CURLOPT_HTTPHEADEREin Array von HTTP-Headern, im Format array('Content-type: text/plain', 'Content-length: 100')CURLOPT_POSTQUOTEEin Array von FTP-Kommandos, die nach dem FTP-Request auf dem Server ausgeführt werden sollen. CURLOPT_QUOTEEin Array von FTP-Kommandos, die vor dem FTP-Request auf dem Server ausgeführt werden sollen. Für die folgenden
option-Parameter solltevalueeine Stream-Resource sein, so wie sie z.B. mittels fopen() erstellt werden kannOption Wert für valueCURLOPT_FILEDie Datei, in die der Transfer geschrieben werden soll. Standard ist STDOUT (der Browser). CURLOPT_INFILEDie Datei die zum Upload gelesen werden soll. CURLOPT_STDERREine Datei, in die Fehler ausgegeben werden, alternativ zu STDERR. CURLOPT_WRITEHEADERIn diese Datei werden die Header eines Transfers geschrieben. Für die folgenden
option-Parameter solltevalueder Name einer gültigen Funktion oder eine Closure sein.Option Wert für valueCURLOPT_HEADERFUNCTIONEin Callback, der zwei Parameter erwartet. Der erste ist die cURL-Resource, der zweite ist ein String mit den zu schreibenden Headern. Bei Nutzung dieser Callback-Funktion liegt die Verantwortung für das Schreiben der Header bei Ihnen. Die Funktion sollte die Anzahl der geschriebenen Bytes zurückgeben. CURLOPT_PASSWDFUNCTIONEin Callback, der drei Parameter erwartet. Der erste ist die cURL-Resource, der zweite ein String der ein Passwort-Prompt enthält, der dritte Parameter enthält die maximal zulässige Länge des Passworts. Die Funktion sollte das Passwort als String zurückgeben. CURLOPT_PROGRESSFUNCTIONEin Callback, die fünf Parameter erwartet. Der erste ist die cURL-Resource, der zweite ist die erwartete Gesamtanzahl von Bytes, die in dieser Übertragung herunter geladen werden, der dritte ist die Anzahl von Bytes die bisher herunter geladen wurden, der vierte ist die erwartete Gesamtanzahl von Bytes, die bei dieser Übertragung hoch geladen werden, und der fünfte ist die Anzahl von Bytes, die bisher hoch geladen wurden.
Hinweis:
Der Callback wird nur aufgerufen, wenn die
CURLOPT_NOPROGRESSOption aufFALSEgesetzt ist.Ein Rückgabewert ungleich 0 bricht die Übertragung ab. In diesem Fall setzt der Transfer einen
CURLE_ABORTED_BY_CALLBACKFehler.CURLOPT_READFUNCTIONEin Callback, der drei Parameter erwartet. Der erste ist die cURL- Resource, der zweite ist eine Stream-Resource, die cURL durch die Option CURLOPT_INFILEzur Verfügung gestellt wird, und der dritte ist die Höchstmenge von Daten die gelesen werden. Der Callback muss eine Zeichenkette mit einer Länge gleich oder kleiner als der angeforderten Datenmenge zurückgeben, typischerweise durch Lesen von der übergebenen Stream-Resource. Er soll eine leere Zeichenkette zurückgeben, um EOF zu signalisieren.CURLOPT_WRITEFUNCTIONEin Callback, der zwei Parameter erwartet. Der erste ist die cURL-Resource, der zweite ist ein String mit den zu schreibenden Daten. Bei Nutzung dieser Callback-Funktion liegt die Verantwortung für das Speichern der Daten bei Ihnen. Die Funktion muss die genaue Anzahl geschriebener Bytes zurückgeben! Andere Werte:
Option Wert für valueCURLOPT_SHAREEin Ergebnis von curl_share_init(). Veranlasst das cURL-Handle die Daten des geteilten Handle zu verwenden.
Rückgabewerte
Gibt bei Erfolg TRUE zurück. Im Fehlerfall wird FALSE zurückgegeben.
Changelog
| Version | Beschreibung |
|---|---|
| 5.6.0 |
CURL_SAFE_UPLOAD ist nun per Voreinstellung TRUE.
|
| 5.6.0 |
CURLOPT_CLOSEPOLICY und begleitende Werte wurden entfernt.
|
| 5.5.0 |
Die cURL-Resource wurde als erstes Argument zum
CURLOPT_PROGRESSFUNCTION Callback hinzugefügt.
|
| 5.5.0 |
CURLOPT_SHARE wurde eingeführt.
|
| 5.3.0 |
CURLOPT_PROGRESSFUNCTION wurde eingeführt.
|
| 5.2.10 |
Es wurden CURLOPT_PROTOCOLS und
CURLOPT_REDIR_PROTOCOLS eingeführt.
|
| 5.1.0 |
Es wurden CURLOPT_AUTOREFERER,
CURLOPT_BINARYTRANSFER,
CURLOPT_FTPSSLAUTH,
CURLOPT_PROXYAUTH und
CURLOPT_TIMECONDITION eingeführt.
|
| 5.0.0 |
Es wurden CURLOPT_FTP_USE_EPRT,
CURLOPT_NOSIGNAL,
CURLOPT_UNRESTRICTED_AUTH,
CURLOPT_BUFFERSIZE,
CURLOPT_HTTPAUTH,
CURLOPT_PROXYPORT,
CURLOPT_PROXYTYPE,
CURLOPT_SSLCERTTYPE und
CURLOPT_HTTP200ALIASES eingeführt.
|
Beispiele
Beispiel #1 Initialisierung einer neuen cURL-Session und das Abrufen einer Webseite
<?php
// erzeuge einen neuen cURL-Handle
$ch = curl_init();
// setze die URL und andere Optionen
curl_setopt($ch, CURLOPT_URL, "http://www.example.com/");
curl_setopt($ch, CURLOPT_HEADER, false);
// führe die Aktion aus und gebe die Daten an den Browser weiter
curl_exec($ch);
// schließe den cURL-Handle und gebe die Systemresourcen frei
curl_close($ch);
?>
Beispiel #2 Datei-Upload
<?php
/* http://localhost/upload.php:
print_r($_POST);
print_r($_FILES);
*/
$ch = curl_init();
$data = array('name' => 'Foo', 'file' => '@/home/user/test.png');
curl_setopt($ch, CURLOPT_URL, 'http://localhost/upload.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_exec($ch);
?>
Das oben gezeigte Beispiel erzeugt folgende Ausgabe:
Array
(
[name] => Foo
)
Array
(
[file] => Array
(
[name] => test.png
[type] => image/png
[tmp_name] => /tmp/phpcpjNeQ
[error] => 0
[size] => 279
)
)
Anmerkungen
Hinweis:
Ein für
CURLOPT_POSTübergebenes Array wird als multipart/form-data, ein URL-kodierter String als application/x-www-form-urlencoded kodiert.