ldap_rename

Function • Params changed in PHP 8.1

Modify the name of an entry.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
Improved
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

ldap_rename Function synopsis

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

Parameters

$ldap

TypeLDAP\Connection

An LDAP\Connection instance, returned by ldap_connect.

$dn

Typestring

The distinguished name of an LDAP entity.

$new_rdn

Typestring

The new RDN.

$new_parent

Typestring

The new parent/superior entry.

$delete_old_rdn

Typebool

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

OptionalType?arrayDefault valuenull

Array of LDAP Controls to send with the request.

Return value

Typebool

Returns true on success, false on failure

Changes to the ldap_rename Function

PHP 8.1

  • Parameter type added for parameter #1 ($ldap): LDAP\Connection
  ldap_rename(
-     $ldap,
+     LDAP\Connection $ldap,
      string $dn,
      string $new_rdn,
      string $new_parent,
      bool $delete_old_rdn,
      ?array $controls = null
    ): bool

PHP 8.0

  • Return type added: bool
  • Parameter name of parameter #1 changed: $link_identifier to $ldap
  • Parameter type added for parameter #2 ($dn): string
  • Parameter name of parameter #3 changed: $newrdn to $new_rdn
  • Parameter type added for parameter #3 ($new_rdn): string
  • Parameter name of parameter #4 changed: $newparent to $new_parent
  • Parameter type added for parameter #4 ($new_parent): string
  • Parameter name of parameter #5 changed: $deleteoldrdn to $delete_old_rdn
  • Parameter type added for parameter #5 ($delete_old_rdn): bool
  • Parameter name of parameter #6 changed: $servercontrols to $controls
  • Parameter type added for parameter #6 ($controls): ?array
  • Parameter default value added for position #6 ($controls): null
  ldap_rename(
-     $link_identifier,
+     $ldap,
-     $dn,
+     string $dn,
-     $newrdn,
+     string $new_rdn,
-     $newparent,
+     string $new_parent,
-     $deleteoldrdn,
+     bool $delete_old_rdn,
-     $servercontrols
+     ?array $controls = null
-   )
+   ): bool

PHP 7.3

  • Optional parameter added - #6: $servercontrols
 ldap_rename(
     $link_identifier,
     $dn,
     $newrdn,
     $newparent,
-    $deleteoldrdn
+    $deleteoldrdn,
+    $servercontrols
   )

ldap_rename Function Availability

PHP VersionAvailability
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 Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes