mb_strimwidth

Function • Params and return types changed in PHP 8.0

Get truncated string with specified width.

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

mb_strimwidth(
    string $string,
    int $start,
    int $width,
    string $trim_marker = "",
    ?string $encoding = null
  ): string

Parameters

$string

Typestring

The string being decoded.

$start

Typeint

The start position offset. Number of characters from the beginning of string (first character is 0), or if start is negative, number of characters from the end of the string.

$width

Typeint

The width of the desired trim. If negative width is specified, count from the end of the string.

$trim_marker

OptionalTypestringDefault value""

A string that is added to the end of string when string is truncated.

$encoding

OptionalType?stringDefault valuenull

Return value

Typestring

The truncated string. If $trim_marker is set, $trim_marker replaces the last chars to match the $width.

Changes to the mb_strimwidth 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 ($width): int
  • Parameter name of parameter #4 changed: $trimmarker to $trim_marker
  • Parameter type added for parameter #4 ($trim_marker): string
  • Parameter default value added for position #4 ($trim_marker): ""
  • Parameter type added for parameter #5 ($encoding): ?string
  • Parameter default value added for position #5 ($encoding): null
  mb_strimwidth(
-     $str,
+     string $string,
-     $start,
+     int $start,
-     $width,
+     int $width,
-     $trimmarker,
+     string $trim_marker = "",
-     $encoding
+     ?string $encoding = null
-   )
+   ): string

mb_strimwidth 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