php8.5
Home/ Manual/ curl / functions/ curl_escape

curl_escape

PHP function Edit on GitHub ✎

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

URL encodes the given string

Description

curl_escape(CurlHandle $handle, string $string): string|false

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

Parameters

string

The string to be encoded.

Return Values

Returns escaped stringFalseforfailure.

Changelog

VersionDescription

Examples

curl_escape() example

php
<?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

// Set options and send HTTP request
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_exec($ch);

?>

See Also

Source: reference/curl/functions/curl-escape.xml · from the official PHP manual (php/doc-en)