mb_substr

Function • Params and return types changed in PHP 8.0

Get part of string.

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

mb_substr Function synopsis

mb_substr(
    string $string,
    int $start,
    ?int $length = null,
    ?string $encoding = null
  ): string

Parameters

$string

Typestring

The string to extract the substring from.

$start

Typeint

If $start is non-negative, the returned string will start at the $start'th position in $string, counting from zero. For instance, in the string 'abcdef', the character at position 0 is 'a', the character at position 2 is 'c', and so forth.

$length

OptionalType?intDefault valuenull

$encoding

OptionalType?stringDefault valuenull

Return value

Typestring

mb_substr returns the portion of $string specified by the $start and $length parameters.

Changes to the mb_substr Function

PHP 8.0

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

mb_substr 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