Funkcja PHP mb_substr() pobiera i zwraca fragment łańcucha znaków PHP określony jako liczba znaków przez argumenty wywołania. Funkcji tej, w odróżnieniu od funkcji PHP substr(), można bezpiecznie używać z łańcuchami znaków o kodowaniu wielobajtowym, takimi jak np. UTF-8.
Składnia funkcji PHP mb_substr()
Funkcja PHP mb_substr() ma następującą składnię:
mb_substr(
string $string,
int $start,
?int $length = null,
?string $encoding = null
): string
Parametry
| Parametr | Opis |
|---|---|
| string | Parametr obowiązkowy. Łańcuch, z którego ma zostać pobrany wycinek. |
| start | Parametr obowiązkowy. Numer pierwszego znaku pobieranego fragmentu łańcucha.
Wartość dodatnia oznacza odliczanie od początku łańcucha i znaki są liczone tak, jak elementy w tablicach, czyli od zera. Wartość ujemna oznacza odliczanie od końca łańcucha i w tym przypadku odliczanie zaczyna się od 1. |
| length | Maksymalna liczba znaków do pobrania z łańcucha PHP. Jeśli argument ten zostanie pominięty lub będzie miał wartość null, funkcja pobierze wszystkie znaki do końca łańcucha. |
| encoding | Określa kodowanie znaków. Pamiętaj, że jeśli nazwa kodowania składa się z kilku członów, to muszą być połączone łącznikiem, np. ISO-8859-2.
Funkcja mb_list_encodings() zwraca listę wszystkich dostępnych kodowań.
|
Wartość zwrotna
Funkcja PHP mb_substr() zwraca część łańcucha.
Typ zwrotny: string.
