A common use for rawurlencode is processing data without rebuilding the operation manually. Percent-encodes a string as a URL component using RFC 3986 rules, representing spaces as %20.
What Is rawurlencode in PHP?
Percent-encodes a string as a URL component using RFC 3986 rules, representing spaces as %20.
Syntax:
rawurlencode(?string $string) : string
Parameters and Return Value
$string— A required string input for this operation. Verify the allowed values in the examples and context below.
Declared return type: string. Distinguish false, an empty result, and exceptions where the API permits them.
Example 1: Basic Usage
This example demonstrates the main operation with a small, controlled input.
<?php
echo rawurlencode("a b");
The example focuses on the value produced or the state changed by this API. Review the return value and validate input before using this pattern in production.
Example 2: Another Input
This example changes the input or surrounding setup to illustrate another behavior.
<?php
echo rawurlencode("folder/report 1.pdf");
The example focuses on the value produced or the state changed by this API. Review the return value and validate input before using this pattern in production.
Practical Example
This application-style example shows a self-contained usage pattern and checks its result.
<?php
$filename = "Quarterly Report.pdf";
$downloadPath = "/files/" . rawurlencode($filename);
echo $downloadPath;
The example focuses on the value produced or the state changed by this API. Review the return value and validate input before using this pattern in production.
Important Behavior and Edge Cases
- Encode individual path segments, not an entire URL with slashes that must be preserved.
- Use the intended input type and handle empty or malformed values explicitly.
- Where this API requires an extension, version, or file, document that dependency before using it in a real application.
Comparison With Related Functions
| Function or Method | When to Use It |
|---|---|
rawurlencode | Percent-encodes a string as a URL component using RFC 3986 rules, representing spaces as %20. |
urlencode | Encodes text for application/x-www-form-urlencoded values, with spaces represented by plus signs. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
| Using this API without checking the required input or extension | Encode individual path segments, not an entire URL with slashes that must be preserved. |
| Encoding an entire URL as a component | Encode only the relevant path segment or query value. |
| Using decoded values as paths without validation | Enforce safe path boundaries after decoding. |
Key Takeaways
- Percent-encodes a string as a URL component using RFC 3986 rules, representing spaces as %20.
- Encode individual path segments, not an entire URL with slashes that must be preserved.
- Test both the expected case and at least one failure or empty-input case before deployment.
Percent-encodes a string as a URL component using RFC 3986 rules, representing spaces as %20. Use it when the operation fits your input, output and validation requirements.