preg_match_all

Список параметров

pattern

Искомый шаблон в виде строки.

subject

Входная строка.

matches

Многомерный массив совпадений, сортировка которого соответствует параметру flags.

flags

Функция возьмёт флаг по умолчанию — PREG_PATTERN_ORDER, если флаг сортировки не передали.

Параметр принимает комбинацию следующих флагов (обратите внимание, указывать флаг PREG_PATTERN_ORDER одновременно с флагом PREG_SET_ORDER бессмысленно):

PREG_PATTERN_ORDER

Флаг упорядочивает результаты так, что элемент $matches[0] содержит массив полных вхождений шаблона, элемент $matches[1] содержит массив вхождений первого подшаблона в круглых скобках и т. д.

<?php

preg_match_all("|<[^>]+>(.*)</[^>]+>|U",
    "<b>Пример: </b><div align=left>это тест</div>",
    $out, PREG_PATTERN_ORDER);
echo $out[0][0] . ", " . $out[0][1] . "\n";
echo $out[1][0] . ", " . $out[1][1] . "\n";

?>

Результат выполнения приведённого примера:

<b>Пример: </b>, <div align=left>это тест</div>
пример: , это тест

Так, элемент $out[0] содержит массив строк, которые соответствуют полному шаблону, а элемент $out[1] содержит массив строк в тегах.

Массив $matches будет дополнительно содержать записи для ключей с именами подшаблонов, если шаблон содержит именованные подшаблоны.

Функция сохранит в элементе $matches[NAME] только самый правый подшаблон, если шаблон содержит повторяющиеся именованные подшаблоны.

<?php

preg_match_all(
    '/(?J)(?<match>foo)|(?<match>bar)/',
    'foo bar',
    $matches,
    PREG_PATTERN_ORDER
);
print_r($matches['match']);

?>

Результат выполнения приведённого примера:

Array
(
    [0] =>
    [1] => bar
)

PREG_SET_ORDER

Флаг упорядочивает результаты так, что элемент $matches[0] становится массивом с первым набором вхождений, а элемент $matches[1] — со вторым набором вхождений и т. д.

<?php

preg_match_all("|<[^>]+>(.*)</[^>]+>|U",
    "<b>пример: </b><div align=\"left\">это тест</div>",
    $out, PREG_SET_ORDER);
echo $out[0][0] . ", " . $out[0][1] . "\n";
echo $out[1][0] . ", " . $out[1][1] . "\n";

?>

Результат выполнения приведённого примера:

<b>пример: </b>, пример:
<div align="left">это тест</div>, это тест

PREG_OFFSET_CAPTURE

С этим флагом для каждой найденной подстроки функция также вернёт позицию подстроки в исходной строке (в байтах). Обратите внимание, что этот флаг изменяет массив matches на многомерный, каждый элемент которого содержит массив, который содержит в индексе с номером 0 найденную подстроку, а смещение этой подстроки в параметре subject — в индексе 1.

<?php

preg_match_all('/(foo)(bar)(baz)/', 'foobarbaz', $matches, PREG_OFFSET_CAPTURE);
print_r($matches);

?>

Результат выполнения приведённого примера:

Array
(
    [0] => Array
        (
            [0] => Array
                (
                    [0] => foobarbaz
                    [1] => 0
                )

        )

    [1] => Array
        (
            [0] => Array
                (
                    [0] => foo
                    [1] => 0
                )

        )

    [2] => Array
        (
            [0] => Array
                (
                    [0] => bar
                    [1] => 3
                )

        )

    [3] => Array
        (
            [0] => Array
                (
                    [0] => baz
                    [1] => 6
                )

        )

)

PREG_UNMATCHED_AS_NULL

С этим флагом несовпадающие подмаски функция представит значениями null; иначе отобразит в виде пустых строк (string).

offset

Обычно поиск выполняется с начала строки слева направо. Через необязательный параметр offset указывают другую позицию (в байтах), с которой функция начнёт поиск.

Замечание:

Поведение параметра offset не эквивалентно замене сопоставляемой строки выражением substr($subject, $offset) при вызове функции preg_match_all(), поскольку шаблон pattern может содержать условия наподобие ^, $ или (?<=x). Примеры смотрите в описании функции preg_match().