preg_match_all

Parâmetros

pattern

A expressão regular a ser procurada, como uma string.

subject

A string de entrada.

matches

Array de todas as correspondências em um array multi-dimensional ordenado de acordo com flags.

flags

Se nenhuma opção de ordenamento for informada, PREG_PATTERN_ORDER será usada.

Pode ser uma combinação das seguintes constantes (observe que não faz sentido usar PREG_PATTERN_ORDER junto com PREG_SET_ORDER):

PREG_PATTERN_ORDER

Ordena os resultados de forma que $matches[0] será um array das correspondências completas à expressão, $matches[1] será um array de strings correspondidas pela primeira sub-expressão entre parênteses, e assim por diante.

<?php
preg_match_all("|<[^>]+>(.*)</[^>]+>|U",
"<b>exemplo: </b><div align=left>isto é um teste</div>",
$out, PREG_PATTERN_ORDER);
echo $out[0][0] . ", " . $out[0][1] . "\n";
echo $out[1][0] . ", " . $out[1][1] . "\n";
?>

O exemplo acima produzirá:

<b>exemplo: </b>, <div align=left>isto é um teste</div>
exemplo: , isto é um teste

Portanto, $out[0] contém um array de strings que corresponderam a toda a expressão, e $out[1] contém um array de strings envolvidas por etiquetas HTML.

Se a expressão contiver sub-expressões nomeadas, $matches conterá, adicionalmente, entradas para chaves com o nome da sub-expressão.

Se a expressão contiver sub-expressões nomeadas duplicadas, somente a mais à direita será armazenada em $matches[NOME].

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

O exemplo acima produzirá:

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

PREG_SET_ORDER

Ordena os resultados de forma que $matches[0] será um array do primeiro conjunto de correspondências, $matches[1] será um array do segundo conjunto, e assim por diante.

<?php
preg_match_all("|<[^>]+>(.*)</[^>]+>|U",
"<b>exemplo: </b><div align=\"left\">isto é um teste</div>",
$out, PREG_SET_ORDER);
echo $out[0][0] . ", " . $out[0][1] . "\n";
echo $out[1][0] . ", " . $out[1][1] . "\n";
?>

O exemplo acima produzirá:

<b>exemplo:: </b>, exemplo::
<div align="left">isto é um teste</div>, isto é um teste

PREG_OFFSET_CAPTURE

Se esta constante for passada, para cada correspondência o deslocamento (em bytes) da string também será retornado. Observe que isto modifica o valor de matches para um array de arrays onde cada elemento é um array que consiste na string correspondida no elemento 0 e seu deslocamento na string subject no elemento 1.

<?php
preg_match_all('/(foo)(bar)(baz)/', 'foobarbaz', $matches, PREG_OFFSET_CAPTURE);
print_r($matches);
?>

O exemplo acima produzirá:

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

Se esta constante for passada, sub-expressões não correspondidas são reportadas como null; caso contrário elas são reportadas como strings vazias.

offset

Normalmente, a pesquisa começa no início da string de entrada. O parâmetro opcional offset pode ser usado para especificar o deslocamento alternativo (em bytes) a partir do qual a pesquisa será iniciada.

Nota:

Usar offset não é equivalente a passar substr($subject, $offset) para preg_match_all() no lugar da string de entrada, porque pattern pode conter afirmações como ^, $ ou (?<=x) que depende da string inteira. Consulte preg_match() para exemplos.