preg_split

FunctionParams and return types changed in PHP 8.0

Split string by a regular expression.

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_split Function synopsis

preg_split(
    string $pattern,
    string $subject,
    int $limit = -1,
    int $flags = 0
  ): array|false

Parameters

$pattern

Typestring

The pattern to search for, as a string.

$subject

Typestring

The input string.

$limit

OptionalTypeintDefault value-1

If specified, then only substrings up to $limit are returned with the rest of the string being placed in the last substring. A $limit of -1 or 0 means "no limit".

$flags

OptionalTypeintDefault value0

$flags can be any combination of the following flags (combined with the | bitwise operator):

$flags accepts the following constant value

Return value

Typearray|false

Returns an array containing substrings of $subject split along boundaries matched by $pattern, or false on failure.

Changes to the preg_split Function

PHP 8.0

  • Return type added: array|false
  • Parameter type added for parameter #1 ($pattern): string
  • Parameter type added for parameter #2 ($subject): string
  • Parameter type added for parameter #3 ($limit): int
  • Parameter default value added for position #3 ($limit): -1
  • Parameter type added for parameter #4 ($flags): int
  • Parameter default value added for position #4 ($flags): 0
  preg_split(
-     $pattern,
+     string $pattern,
-     $subject,
+     string $subject,
-     $limit,
+     int $limit = -1,
-     $flags
+     int $flags = 0
-   )
+   ): array|false

preg_split 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