Get part of string (original) (raw)

mb_strcut

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

mb_strcut — Get part of string

Description

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

Parameters

str

The string being cut.

start

If start is non-negative, the returned string will start at the start'th byte position instr, counting from zero. For instance, in the string 'abcdef', the byte at position 0 is 'a', the byte at position 2 is 'c', and so forth.

If start is negative, the returned string will start at the start'th byte counting back from the end of str. However, if the magnitude of a negative start is greater than the length of the string, the returned portion will start from the beginning ofstr.

length

Length in bytes. If omitted or NULL is passed, extract all bytes to the end of the string.

If length is negative, the returned string will end at the length'th byte counting back from the end of str. However, if the magnitude of a negativelength is greater than the number of characters after the start position, an empty string will be returned.

encoding

The encodingparameter is the character encoding. If it is omitted, the internal character encoding value will be used.

Return Values

mb_strcut() returns the portion ofstr specified by thestart andlength parameters.

Changelog

Version Description
5.4.8 Passing NULL as length extracts all bytes to the end of the string. Prior to this versionNULL was treated the same as 0.

See Also