Funkcja PHP preg_split() dzieli łańcuch znaków wg ciągu znaków pasującego do wzorca reprezentowanego przez wyrażenie regularne.
Składnia funkcji PHP preg_split()
Funkcja PHP preg_split() ma następującą składnię:
preg_split(
string $pattern,
string $subject,
int $limit = -1,
int $flags = 0
): array|false
Parametry
| Parametr | Opis |
|---|---|
| pattern | Parametr obowiązkowy. Wzorzec reprezentujący ciąg znaków, wg którego ma zostać podzielony łańcuch. |
| subject | Parametr obowiązkowy. Łańcuch znaków, który ma zostać podzielony. |
| limit | Określa maksymalną liczbę fragmentów łańcucha, jaka ma zostać zwrócona. Jeśli po jej wyczerpaniu pozostanie jeszcze jakaś część łańcucha, to zostaje ona zapisana w całości w ostatnim elemencie zwróconej tablicy. Wartość -1 lub 0 oznacza brak ograniczenia. |
| flags | Dostępne są następujące flagi, które można łączyć bitowym operatorem | (lub):
|
Wartość zwrotna
Funkcja PHP preg_split() zwraca tablicę, której elementami są fragmenty łańcucha podzielonego wg ciągu znaków reprezentowanego przez wzorzec wyrażenia regularnego, lub false.
Dodatkowy przykład
Poniżej znajduje się przykład użycia funkcji preg_split() z wszystkimi czterema argumentami wywołania.
$test = 'Ala ma kota';
print_r(preg_split('/\s/', $test, 2, PREG_SPLIT_OFFSET_CAPTURE));Wynik:
Array
(
[0] => Array
(
[0] => Ala
[1] => 0
)
[1] => Array
(
[0] => ma kota
[1] => 4
)
)
Funkcja zwróciła tylko dwa elementy, ponieważ parametr limit ma wartość 2, oraz dołączyła informację o indeksie początkowym każdego zwróconego elementu, ponieważ w czwartym argumencie wywołania znajduje się flaga PREG_SPLIT_OFFSET_CAPTURE.
