SunshinePHP Developer Conference 2015

curl_escape

(PHP 5 >= 5.5.0)

curl_escapeURL encodes the given string

Description

string curl_escape ( resource $ch , string $str )

This function URL encodes the given string according to » RFC 3986.

Parameters

ch

A cURL handle returned by curl_init().

str

The string to be encoded.

Return Values

Returns escaped string or FALSE on failure.

Examples

Example #1 curl_escape() example

<?php
// Create a curl handle
$ch curl_init();

// Escape a string used as a GET parameter
$location curl_escape($ch'Hofbräuhaus / München');
// Result: Hofbr%C3%A4uhaus%20%2F%20M%C3%BCnchen

// Compose an URL with the escaped string
$url "http://example.com/add_location.php?location={$location}";
// Result: http://example.com/add_location.php?location=Hofbr%C3%A4uhaus%20%2F%20M%C3%BCnchen

// Send HTTP request and close the handle
curl_setopt($chCURLOPT_URL$url);
curl_setopt($chCURLOPT_RETURNTRANSFERtrue);
curl_exec($ch);
curl_close($ch);
?>

See Also

add a note add a note

User Contributed Notes 2 notes

up
2
Nico
22 days ago
What is difference between this function and urlencode()?
up
1
Franois
10 days ago
This function is strictly equivalent to rawurlencode().

Internally it uses curl_easy_escape() from libcurl, whose doc says: "This function converts the given input string to an URL encoded string (…). All input characters that are not a-z, A-Z, 0-9, '-', '.', '_' or '~' are converted to their "URL escaped" version (%NN where NN is a two-digit hexadecimal number)."
To Top