strspn

Function • Params and return types changed in PHP 8.0

Finds the length of the initial segment of a string consisting entirely of characters contained within a given mask.

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

strspn Function synopsis

strspn(
    string $string,
    string $characters,
    int $offset = 0,
    ?int $length = null
  ): int

Parameters

$string

Typestring

The string to examine.

$characters

Typestring

The list of allowable characters.

$offset

OptionalTypeintDefault value0

The position in $string to start searching.

$length

OptionalType?intDefault valuenull

The length of the segment from $string to examine.

Return value

Typeint

Returns the length of the initial segment of $string which consists entirely of characters in $characters.

When a [`$offset`](#param-offset) parameter is set, the returned length
is counted starting from this position, not from the beginning of
[`$string`](#param-string).

Changes to the strspn Function

PHP 8.0

  • Return type added: int
  • Parameter name of parameter #1 changed: $str to $string
  • Parameter type added for parameter #1 ($string): string
  • Parameter name of parameter #2 changed: $mask to $characters
  • Parameter type added for parameter #2 ($characters): string
  • Parameter name of parameter #3 changed: $start to $offset
  • Parameter type added for parameter #3 ($offset): int
  • Parameter default value added for position #3 ($offset): 0
  • Parameter name of parameter #4 changed: $len to $length
  • Parameter type added for parameter #4 ($length): ?int
  • Parameter default value added for position #4 ($length): null
  strspn(
-     $str,
+     string $string,
-     $mask,
+     string $characters,
-     $start,
+     int $offset = 0,
-     $len
+     ?int $length = null
-   )
+   ): int

strspn 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