Home/ Manual/ ldap / functions/ ldap_rename

ldap_rename

PHP function Edit on GitHub ✎

(PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8)

Modify the name of an entry

Description

ldap_rename(LDAP\Connection $ldap, string $dn, string $new_rdn, string $new_parent, bool $delete_old_rdn, array|null $controls = null): bool

The entry specified by dn is renamed/moved.

Parameters

ldap: Ldap
dn: The distinguished name of an LDAP entity.
new_rdn: The new RDN.
new_parent: The new parent/superior entry.
delete_old_rdn: If true the old RDN value(s) is removed, else the old RDN value(s) is retained as non-distinguished values of the entry.
controls: Array of LDAP Controls to send with the request.

Return Values

Success

Changelog

Version	Description
7.3.0	Support for `controls` added

Notes

Note

This function currently only works with LDAPv3. You may have to use ldap_set_option() prior to binding to use LDAPv3. This function is only available when using OpenLDAP 2.x.x OR Netscape Directory SDK x.x.