Função preg_match

A função preg_match busca em uma string por correspondências com uma expressão regular. O primeiro parâmetro aceita o padrão da expressão regular, o segundo - a string para busca, o terceiro (opcional) - um array para armazenar as correspondências encontradas, o quarto (opcional) - flags, o quinto (opcional) - o deslocamento do início da busca.

Sintaxe

phppreg_match(pattern, subject, [matches], [flags], [offset]);

Flags

Flag Constante Descrição
PREG_PATTERN_ORDER 1 Os resultados são ordenados por padrões (padrão)
PREG_SET_ORDER 2 Os resultados são ordenados por conjuntos de correspondências
PREG_OFFSET_CAPTURE 256 Retorna a posição da correspondência na string
PREG_UNMATCHED_AS_NULL 512 Subpadrões não correspondentes são retornados como NULL

Exemplo

Vamos verificar se uma string contém dígitos:

php<?php
  $res = preg_match('/\d+/', 'abc123');
  echo $res;
?>

Resultado da execução do código:

php1

Exemplo

Vamos extrair todos os dígitos da string para um array:

php<?php
  preg_match('/\d+/', 'abc123', $matches);
  var_dump($matches);
?>

Resultado da execução do código:

php[0 => '123']

Exemplo

Uso de grupos nomeados na expressão regular:

php<?php
  preg_match('/(?P<name>\w+)\s+(?P<age>\d+)/', 'John 25', $matches);
  var_dump($matches);
?>

Resultado da execução do código:

php[
  0 => 'John 25',
  'name' => 'John',
  1 => 'John',
  'age' => '25',
  2 => '25'
]

Exemplo

Uso da flag PREG_OFFSET_CAPTURE para obter a posição da correspondência:

php<?php
  preg_match('/\d+/', 'abc123', $matches, PREG_OFFSET_CAPTURE);
  var_dump($matches);
?>

Resultado da execução do código:

php[
  0 => [
    0 => '123',
    1 => 3
  ]
]

Exemplo

Busca com especificação de deslocamento (offset):

php<?php
  preg_match('/\d+/', '123abc456', $matches, 0, 3);
  var_dump($matches);
?>

Resultado da execução do código:

php[0 => '456']

Exemplo

Verificação da validade de um endereço de email:

php<?php
  $email = 'test@example.com';
  $res = preg_match('/^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/', $email);
  echo $res ? 'Válido' : 'Inválido';
?>

Resultado da execução do código:

php'Válido'

Veja também

  • a função preg_match_all,
    que busca todas as correspondências em uma string
  • a função preg_replace,
    que executa substituição por expressão regular