iterator_apply

Function • Params and return types changed in PHP 8.0

Call a function for every element in an iterator.

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

iterator_apply Function synopsis

iterator_apply(
    Traversable $iterator,
    callable $callback,
    ?array $args = null
  ): int

Parameters

$iterator

TypeTraversable

$callback

Typecallable

The callback function to call on every element. This function only receives the given $args, so it is nullary by default. If count($args) === 3, for instance, the callback function is ternary.

$args

OptionalType?arrayDefault valuenull

Return value

Typeint

Changes to the iterator_apply Function

PHP 8.0

  • Return type added: int
  • Parameter name of parameter #2 changed: $function to $callback
  • Parameter type added for parameter #2 ($callback): callable
  • Parameter type changed for parameter #3 ($args): array or NULL to ?array
  • Parameter default value added for position #3 ($args): null
  iterator_apply(
      Traversable $iterator,
-     $function,
+     callable $callback,
-     array or NULL $args
+     ?array $args = null
-   )
+   ): int

iterator_apply 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