preg_grep

Function • Params and return types changed in PHP 8.0

Return array entries that match the pattern.

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

preg_grep Function synopsis

preg_grep(
    string $pattern,
    array $array,
    int $flags = 0
  ): array|false

Parameters

$pattern

Typestring

The pattern to search for, as a string.

$array

Typearray

The input array.

$flags

OptionalTypeintDefault value0

If set to PREG_GREP_INVERT, this function returns the elements of the input array that do not match the given $pattern.

$flags accepts the following constant value

Return value

Typearray|false

Returns an array indexed using the keys from the $array array, or false on failure.

Changes to the preg_grep Function

PHP 8.0

  • Return type added: array|false
  • Parameter name of parameter #1 changed: $regex to $pattern
  • Parameter type added for parameter #1 ($pattern): string
  • Parameter name of parameter #2 changed: $input to $array
  • Parameter type added for parameter #2 ($array): array
  • Parameter type added for parameter #3 ($flags): int
  • Parameter default value added for position #3 ($flags): 0
  preg_grep(
-     $regex,
+     string $pattern,
-     $input,
+     array $array,
-     $flags
+     int $flags = 0
-   )
+   ): array|false

preg_grep 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