Home/ Manual/ ldap / functions/ ldap_connect

ldap_connect

PHP function Edit on GitHub ✎

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

Connect to an LDAP server

Description

ldap_connect(string|null $uri = null): LDAP\Connection|false

Warning

As of PHP 8.3.0, the following signature is deprecated.

ldap_connect(string|null $host = null, int $port = 389): LDAP\Connection|false

Creates an LDAP\Connection instance and checks whether the given uri is plausible.

Note

This function does not open a network connection. It only validates the URI syntax and initializes connection parameters. The actual TCP connection is established when ldap_bind() is called.

Note

Options that affect the connection setup, such as LDAP_OPT_PROTOCOL_VERSION and TLS-related options (LDAP_OPT_X_TLS_*), must be set using ldap_set_option() after calling this function and before calling ldap_bind(). TLS-related options must be set globally (by passing null as the first argument to ldap_set_option()).

Parameters

uri

A full LDAP URI of the form ldap://hostname:port or ldaps://hostname:port for SSL encryption.

You can also provide multiple LDAP-URIs separated by a space as one string

Note that hostname:port is not a supported LDAP URI as the schema is missing.

host

The hostname to connect to.

port

The port to connect to.

Return Values

Returns an LDAP\Connection instance when the provided LDAP URI seems plausible. It's a syntactic check of the provided parameter but the server(s) will not be contacted! If the syntactic check fails it returns false. ldap_connect() will otherwise return a LDAP\Connection instance as it does not actually connect but just initializes the connecting parameters. The actual connect happens with the next calls to ldap_* functions, usually with ldap_bind().

If no argument is specified then the LDAP\Connection instance of the already opened connection will be returned.

Changelog

Version	Description
8.5.0	Calling `ldap_connect()` with Oracle wallet arguments is deprecated. Oracle LDAP (Oracle Instant Client) support is deprecated as of PHP 8.5.0.
8.4.0	Calling `ldap_connect()` with more than two arguments is now deprecated.
8.3.0	Calling `ldap_connect()` with separate `hostname` and `port` is now deprecated.
8.1.0	Returns an `LDAP\Connection` instance now; previously, a Resource was returned.

Examples

Example of connecting to LDAP server.

php

<?php

// LDAP variables
$ldapuri = "ldap://ldap.example.com:389";  // your ldap-uri

// Connecting to LDAP
$ldapconn = ldap_connect($ldapuri)
          or die("That LDAP-URI was not parseable");

?>

Example of connecting securely to LDAP server.

php

<?php

// make sure your host is the correct one
// that you issued your secure certificate to
$ldaphost = "ldaps://ldap.example.com/";

// Connecting to LDAP
$ldapconn = ldap_connect($ldaphost)
          or die("That LDAP-URI was not parseable");

?>