mb_strcut()

mb_strcut() — Get part of string.

Built-in function of PHP 8.5. The manual lists it as available in PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.

What it does

mb_strcut() extracts a substring from a string similarly to mb_substr(), but operates on bytes instead of characters. If the cut position happens to be between two bytes of a multi-byte character, the cut is performed starting from the first byte of that character. This is also the difference to the substr() function, which would simply cut the string between the bytes and thus result in a malformed byte sequence.

Signature

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

Parameters

Parameter	Type	What it takes
$string	string	The string being cut.
$start	int	If start is non-negative, the returned string will start at the start'th byte position in string, counting from zero. For instance, in the string 'abcdef', the byte at position 0 is 'a', the byte at position 2 is 'c', and so forth.
$length	?int	If length is negative, the returned string will end at the length'th byte counting back from the end of string. However, if the magnitude of a negative length is greater than the number of characters after the start position, an empty string will be returned.
$encoding	?string	The encoding parameter is the character encoding. If it is omitted or null, the internal character encoding value will be used.

Return value

mb_strcut() returns the portion of string specified by the start and length parameters.

Example

The PHP manual ships no example for mb_strcut(); the signature and the parameter table above are the contract.

Changelog

Version	Change
8.4.0	The behavior is more consistent now on invalid UTF-8 and UTF-16 strings.
8.0.0	encoding is nullable now.
8.0.0	Now throws a ValueError if encoding is an invalid encoding. Previously, an E_WARNING was emitted and false was returned.