mb_substr
(PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8)
Get part of string
Description
Performs 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
stringThe
stringto extract the substring from.startIf
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.lengthMaximum number of characters to use from
string. If omitted or null is passed, extract all characters to the end of the string.encodingParameter
Return Values
mb_substr() returns the portion of string specified by the start and length parameters.
Changelog
| Version | Description |
|---|---|
| 8.3.2 | On invalid strings (those with encoding errors), character indices are now interpreted in the same manner as most other mbstring functions. This means that character indices returned by mb_strpos() can be passed directly. For SJIS-mac (MacJapanese) strings, character indices now refer to the indices of the Unicode codepoints produced when the string is converted to Unicode, which differ from the character indices for the SJIS-mac characters that convert to a sequence of several codepoints. |