mb_substr
(PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8)
mb_substr — Get part of string
Description
mb_substr(
string $string,
int $start,
?int $length = null,
?string $encoding = null
): stringPerforms a multi-byte safe substr() operation based on number of characters. Position is counted from the beginning of string. First character's position is 0. Second character position is 1, and so on.
Parameters
string-
The string to extract the substring from.
start-
If
startis non-negative, the returned string will start at thestart'th position instring, counting from zero. For instance, in the string 'abcdef', the character at position0is 'a', the character at position2is 'c', and so forth.If
startis negative, the returned string will start at thestart'th character from the end ofstring. length-
Maximum number of characters to use from
string. If omitted orNULLis passed, extract all characters to the end of the string. encoding-
The
encodingparameter is the character encoding. If it is omitted ornull, the internal character encoding value will be used.
Return Values
mb_substr() returns the portion of string specified by the start and length parameters.
Changelog
| Version | Description |
|---|---|
| 8.0.0 | encoding is nullable now. |
See Also
- mb_strcut() - Get part of string
- mb_internal_encoding() - Set/Get internal character encoding
© 1997–2023 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.mb-substr.php