phpday 2025 - Call For Papers

mb_strcut

(PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8)

mb_strcutПолучает часть строки

Описание

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

Функция mb_strcut() вырезает подстроку из строки так же, как функция mb_substr(), но оперирует байтами, а не символами. Если начало вырезаемой части попадает между байтами одного символа, функция вырежет подстроку, начиная с первого байта этого символа. Это существенное отличие от функции substr(), которая просто вырежет подстроку, начиная с середины символа, и этим нарушит последовательность байтов в строке.

Список параметров

string

Обрезаемая строка.

start

Если значение параметра start неотрицательное, возвращённая строка начнётся с позиции start в байтах от начала строки string, считая с нуля. Например, в строке «abcdef» байт в позиции 0 — это «a», байт в позиции 2 — «c» и т. д.

Если значение параметра start отрицательное, возвращаемая строка будет начинаться с байта start с обратным отсчётом от конца строки string. Однако, если величина отрицательного start превышает длину строки, возвращаемая часть начнётся с начала параметра string.

length

Длина подстроки в байтах. Если не указана, то передаётся значение NULL и вырезаются все байты до конца строки.

Если значение параметра length отрицательное, возвращаемая строка будет заканчиваться байтом length с обратным отсчётом от конца строки string. Однако, если величина отрицательного значения length превышает число символов после позиции start, будет возвращена пустая строка.

encoding

Параметр encoding устанавливает кодировку символов. Функция установит для параметра значение внутренней кодировки символов, если аргумент не передали или передали значение null.

Возвращаемые значения

Возвращает часть строки string, которую задали аргументами start и length.

Список изменений

Версия Описание
8.0.0 Теперь параметр encoding принимает значение null.

Смотрите также

  • mb_substr() - Возвращает часть строки
  • mb_internal_encoding() - Устанавливает или получает внутреннюю кодировку символов файла скрипта

Добавить

Примечания пользователей 4 notes

up
4
olivthill at gmail dot com
7 years ago
Here is an example with UTF8 characters, to see how the start and length arguments are working:

$str_utf8 = utf8_encode("Déjà_vu");
$str_utf8_0 = mb_strcut($str_utf8, 0, 4, "UTF-8"); // Déj
$str_utf8_1 = mb_strcut($str_utf8, 1, 4, "UTF-8"); // éj
$str_utf8_2 = mb_strcut($str_utf8, 2, 4, "UTF-8"); // éj
$str_utf8_3 = mb_strcut($str_utf8, 3, 4, "UTF-8"); // jà_
$str_utf8_4 = mb_strcut($str_utf8, 4, 4, "UTF-8"); // à_v

The string includes two special charaters, "é" and "à" internally coded with two bytes.
Note that a multibyte character is removed rather than kept in half at the end of the output.
Note also that the result is the same for a cut 1,4 and a cut 2,4 with this string.
up
4
t dot starling at physics dot unimelb dot edu dot au
20 years ago
What the manual and the first commenter are trying to say is that mb_strcut uses byte offsets, as opposed to mb_substr which uses character offsets.

Both mb_strcut and mb_substr appear to treat negative and out-of-range offsets and lengths in the basically the same way as substr. An exception is that if start is too large, an empty string will be returned rather than FALSE. Testing indicates that mb_strcut first works out start and end byte offsets, then moves each offset left to the nearest character boundary.
up
1
David Juhasz
3 years ago
This was driving me crazy, because mb_strcut() kept returning an empty string. The $length parameter seems to have a max value of 2^32-1 (2147483647).

Works:
<?php
# output: Полуустав
echo mb_strcut('Полуустав', 0, pow(2,31)-1);
?>

Doesn't work:
<?php
# nothing is output
echo mb_strcut('Полуустав', 0, pow(2,31));
?>

My PHP_INT_MAX value is much larger than 2^32-1, so I'm not sure why larger values for $length don't work. :(

<?php
# output: 9223372036854775807
echo PHP_INT_MAX;
?>
up
-1
oyag02 at yahoo dot co dot jp
21 years ago
diffrence between mb_substr and mb_substr

example:
mb_strcut('I_ROHA', 1, 2) returns 'I_'. Treated as byte stream.
mb_substr('I_ROHA', 1, 2) returns 'ROHA' Treated as character stream.

# 'I_' 'RO' 'HA' means multi-byte character
To Top