ldap_error

(PHP 4, PHP 5, PHP 7, PHP 8)

ldap_errorReturn the LDAP error message of the last LDAP command

Description

ldap_error(LDAP\Connection $ldap): string

Returns the string error message explaining the error generated by the last LDAP command for the given ldap. While LDAP errno numbers are standardized, different libraries return different or even localized textual error messages. Never check for a specific error message text, but always use an error number to check.

Unless you lower your warning level in your php.ini sufficiently or prefix your LDAP commands with @ (at) characters to suppress warning output, the errors generated will also show up in your HTML output.

Parameters

ldap

An LDAP\Connection instance, returned by ldap_connect().

Return Values

Returns string error message.

Changelog

Version Description
8.1.0 The ldap parameter expects an LDAP\Connection instance now; previously, a valid ldap link resource was expected.

See Also

  • ldap_err2str() - Convert LDAP error number into string error message
  • ldap_errno() - Return the LDAP error number of the last LDAP command

add a note

User Contributed Notes 2 notes

up
15
Michael Newton
6 years ago
Note that you can sometimes get more detailed error messages by getting the value of the LDAP_OPT_DIAGNOSTIC_MESSAGE option.

For example, after a recent connection error the two gave very different info:

<?php
$conn
= ldap_connect($server);
ldap_search($conn, $dn, $query);

echo
"ldap_error: " . ldap_error($conn);
ldap_get_option($conn, LDAP_OPT_DIAGNOSTIC_MESSAGE, $err);
echo
"ldap_get_option: $err";
?>

This resulted in:

ldap_error: Can't contact LDAP server
ldap_get_option: TLS: hostname does not match CN in peer certificate
up
5
edA-qa at disemia dot com
16 years ago
For those wondering, this function appears to do the same thing as:
<?php
ldap_err2str
( ldap_errno() );
?>
To Top