mb_scrub

Function • Params and return types changed in PHP 8.0

Replace ill-formed byte sequences with the substitute character.

PHP 5
PHP 7.0-7.1
PHP 7.2
Added
PHP 7.3-7.4
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

mb_scrub Function synopsis

mb_scrub(string $string, ?string $encoding = null): string

Parameters

$string

Typestring

The input string.

$encoding

OptionalType?stringDefault valuenull

The encoding used to interpret $string. If it is omitted or null, the mbstring.internal_encodingsetting will be used if set, otherwise the default_charsetsetting will be used.

Return value

Typestring

The string result with invalid byte sequences replaced.

Changes to the mb_scrub 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 ($encoding): ?string
  • Parameter default value added for position #2 ($encoding): null
- mb_scrub($str, $encoding)
+ mb_scrub(string $string, ?string $encoding = null): string

PHP 7.2

  • Function added

mb_scrub 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 No
PHP 7.0Unsupported No
PHP 5.6Unsupported No
PHP 5.5Unsupported No
PHP 5.4Unsupported No
PHP 5.3Unsupported No