iconv_substr

(PHP 5, PHP 7, PHP 8)

iconv_substr — Elimina parte del string

Descripción

iconv_substr(
    string $str,
    int $offset,
    int $length = iconv_strlen($str, $charset),
    string $charset = ini_get("iconv.internal_encoding")
): string

Corta una parte de str especificada por los parámetros offset y length.

Parámetros

str

El string original.

offset

Si offset no es negativo, iconv_substr() elimina la porción de str que empieza en el caracter número offset, empezando de cero.

Si offset es negativo, iconv_substr() elimina la parte que empieza en esa posición, offset caracteres desde el final de str.

length

Si se da el parámetro length y es positivo, el valor retornado contendrá como mucho length caracteres de la porción que comienza en offset (dependiendo de la longitud de string).

Si se indica un valor negativo en length, iconv_substr() elimina la porción de str desde la posición offset hasta el caracter que está length caracteres desde el final del string. En caso de que offset sea también negativo, la posición de inicio se calcula de antemano de acuerdo con la regla explicada anteriormente.

charset

Si se omite el parámetro charset, se asume que string se codifica en iconv.internal_encoding.

Notar que se considera que los parámetros offset y length representan offsets que se calculan en base a la codificación de caracteres determinada en charset, mientras que por otro lado, substr() siempre los toma como offset de bytes.

Valores devueltos

Retorna la parte de str especificada por los parámetros offset y length

Si str tiene un tamaño más corto que offset, se retornará false. Si str tiene exactamente un número de caracteres igual a offset, entonces devolverá un string vacío.

Historial de cambios

Versión	Descripción
7.0.11	Si la longitud de caracteres de `str` es igual a `offset`, devolverá un string vacío. Antes de ésta versión, un `false` era devuelto en éste caso.

Ver también

substr() - Devuelve parte de una cadena
mb_substr() - Obtiene parte de una cadena de caracteres
mb_strcut() - Obtener parte de un string

add a note

User Contributed Notes 2 notes

down

-2

doru87 at gmail dot com ¶

14 years ago


just fyi, iconv_substr() unknown error (0) has been resolved in PHP 5.2

you can also try mb_substr() or just substr() when dealing with this issue. Unfortunately there is no way to fix it in versions prior to 5.2.

Regards,
Teodor Sandu

down

-8

qbolec at terra dot es ¶

17 years ago


<?=
iconv_substr("A",0,1);
?>
generates folowing error:
Notice: iconv_substr() [function.iconv-substr]: Unknown error (0) in [...]

while, <?= iconv_substr("AB",0,1) ?> and <?= iconv_substr("AB",0,2) ?>
work as expected.

add a note