ldap_get_option

Function • Params changed in PHP 8.5

Get the current value for given option.

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

ldap_get_option Function synopsis

ldap_get_option(
    ?LDAP\Connection $ldap,
    int $option,
    &$value = null
  ): bool

Parameters

$ldap

Type?LDAP\Connection

An LDAP\Connection instance, returned by ldap_connect.

$option

Typeint

The parameter $option can be one of:

$value

Passed by reference, OptionalDefault valuenull

This will be set to the option value.

Note that the parameter $value is passed by reference, and contains additional/updated context data that may be useful.

Return value

Typebool

Returns true on success, false on failure

Changes to the ldap_get_option Function

PHP 8.5

  • Parameter type changed for parameter #1 ($ldap): LDAP\Connection to ?LDAP\Connection
  ldap_get_option(
-     LDAP\Connection $ldap,
+     ?LDAP\Connection $ldap,
      int $option,
      &$value = null
    ): bool

PHP 8.1

  • Parameter type added for parameter #1 ($ldap): LDAP\Connection
  ldap_get_option(
-     $ldap,
+     LDAP\Connection $ldap,
      int $option,
      &$value = 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 ($option): int
  • Parameter name of parameter #3 changed: $retval to $value
  • Parameter default value added for position #3 ($value): null
  ldap_get_option(
-     $link_identifier,
+     $ldap,
-     $option,
+     int $option,
-     &$retval
+     &$value = null
-   )
+   ): bool

ldap_get_option Function Availability

PHP VersionAvailability
PHP 8.6Future Release Yes
PHP 8.5Upcoming Release Yes
PHP 8.4Supported (Latest) Yes
PHP 8.3Supported Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Security-Fixes Only 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