mb_strcut

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

mb_strcut — Obtener parte de un string

Descripción

mb_strcut(
    string $str,
    int $start,
    int $length = NULL,
    string $encoding = mb_internal_encoding()
): string

mb_strcut() extrae un substring de un string de forma similar a mb_substr(), pero opera sobre bytes en lugar de caracteres. Si la posición de corte ocurre entre dos bytes de un carácter multibyte, dicho corte se realiza empezando desde el primer byte del carácter. Esta es también la diferencia con la función substr(), la cual simplemente cortaría el string entre los bytes, resultando así una secuencia de bytes malformada.

Parámetros

str

El string a cortar.

start

Si start no es negativo, el string devuelto comenzará en la posición del byte start-ésima de string, empezando desde cero. Por ejemplo, en el string 'abcdef', el byte en la posición 0 es 'a', el byte en la posición 2 es 'c', etc.

Si start es negative, el string devuelto comenzará en el byte start-ésimo desde el final de string.

length

La longitud en bytes. Si se omite o se pasa NULL, extrae todos los bytes hasta el final del string.

encoding

El parámetro encoding es la codificación de caracteres. Si es omitido, será usado el valor de la codificación de caracteres interna.

Valores devueltos

mb_strcut() devuelve la porción de str especificada por los parámetros start y length.

Historial de cambios

Versión	Descripción
5.4.8	Pasar `NULL` al parámetro `length` extrae todos los bytes hasta el final de string. Antes de esta versión, `NULL` era tratado de igual modo que `0`.

Ver también

mb_substr() - Obtiene parte de una cadena de caracteres
mb_internal_encoding() - Establece/obtiene la codificación de caracteres interna

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 4 notes

down

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.

down

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.

down

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;
?>

down

-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

＋add a note