Funkcja PHP substr() pobiera i zwraca fragment łańcucha znaków PHP określony przez argumenty wywołania.
Funkcja ta operuje na bajtach, nie na znakach, i dlatego powinno się jej używać tylko z łańcuchami o kodowaniu jednobajtowym, tzn. takim, w którym każdemu znakowi odpowiada dokładnie jeden bajt, jak np. ISO 8859-2.
Do pracy z łańcuchami o kodowaniu wielobajtowym, jak np. UTF-8, bezpieczniej jest używać funkcji mb_substr().
Składnia funkcji PHP substr()
Funkcja PHP substr() ma następującą składnię:
substr(string $string, int $offset, ?int $length = null): stringParametry
| Parametr | Opis |
|---|---|
| string | Parametr obowiązkowy. Łańcuch, z którego ma zostać pobrany fragment. |
| offset | 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. Jeśli długość łańcucha jest mniejsza od wartości argumentu |
| length | Maksymalna liczba znaków do pobrania z łańcucha PHP od znaku wskazywanego przez parametr offset.
Jeśli argument ten ma wartość ujemną, to funkcja pobierze łańcuch zaczynający się w miejscu wskazywanym przez argument Gdy argument Jeśli argument ten zostanie pominięty lub będzie miał wartość null, funkcja pobierze wszystkie znaki do końca łańcucha. |
Wartość zwrotna
Funkcja PHP substr() zwraca fragment łańcucha.
Typ zwrotny: string.
