ldap_escape
Function • Params and return types changed in PHP 8.0
Escape a string for use in an LDAP filter or DN.
ldap_escape Function synopsis
ldap_escape(
string $value,
string $ignore = "",
int $flags = 0
): string
Parameters
$value
Typestring
The value to escape.
$ignore
OptionalTypestringDefault value""
Characters to ignore when escaping.
$flags
OptionalTypeintDefault value0
The context the escaped string will be used in:
LDAP_ESCAPE_FILTER for filters to be used with
ldap_search, or
LDAP_ESCAPE_DN for DNs.
If neither flag is passed, all chars are escaped.
Return value
Typestring
Returns the escaped string.
Changes to the ldap_escape Function
PHP 8.0
- Return type added:
string - Parameter type added for parameter #1 (
$value):string - Parameter type added for parameter #2 (
$ignore):string - Parameter default value added for position #2 (
$ignore):"" - Parameter type added for parameter #3 (
$flags):int - Parameter default value added for position #3 (
$flags):0
ldap_escape(
- $value,
+ string $value,
- $ignore,
+ string $ignore = "",
- $flags
+ int $flags = 0
- )
+ ): string PHP 5.6
- Function added
ldap_escape Function Availability
ldap_escape Function Availability| PHP Version | Availability |
|---|---|
| PHP 8.6Upcoming Release | Yes |
| PHP 8.5Supported (Latest) | Yes |
| PHP 8.4Supported | Yes |
| PHP 8.3Security-Fixes Only | Yes |
| PHP 8.2Security-Fixes Only | Yes |
| PHP 8.1Unsupported | Yes |
| PHP 8.0Unsupported | Yes |
| PHP 7.4Unsupported | Yes |
| PHP 7.3Unsupported | Yes |
| PHP 7.2Unsupported | Yes |
| PHP 7.1Unsupported | Yes |
| PHP 7.0Unsupported | Yes |
| PHP 5.6Unsupported | Yes |
| PHP 5.5Unsupported | No |
| PHP 5.4Unsupported | No |
| PHP 5.3Unsupported | No |