mb_ereg_search_regs

Description
Syntax
Examples
Links

Description

The mb_ereg_search_regs of Multibyte String for PHP returns the matched part of a multibyte regular expression.

Syntax

mb_ereg_search_regs(
    ?string $pattern = null,
    ?string $options = null
): array|false

Parameters

options

The search option.

Option	Description
i	Ambiguity match on
x	Enables extended pattern form
m	'.' matches with newlines
s	'^' -> '\A', '$' -> '\Z'
p	Same as both the m and s options
l	Finds longest matches
n	Ignores empty matches

Executes the multibyte regular expression match, and if there are some matched part, it returns an array including substring of matched part as first element, the first grouped part with brackets as second element, the second grouped part as third element, and so on. It returns false on error.

Examples

1 · void

<?

$string = '🐘string';
$pattern = '🐘(st(r(i)ng))';

mb_ereg_search_init($string, $pattern);

$return = mb_ereg_search_regs();

var_export($return);

array (
  0 => '🐘string',
  1 => 'string',
  2 => 'ring',
  3 => 'i',
)

2 · pattern

<?

$string = '🐘string';

mb_ereg_search_init($string);

$pattern = '🐘(st(r(i)ng))';

$return = mb_ereg_search_regs($pattern);

var_export($return);

array (
  0 => '🐘string',
  1 => 'string',
  2 => 'ring',
  3 => 'i',
)

3 · options · i

<?

$string = '🐘string';

mb_ereg_search_init($string);

$pattern = '🐘STRING';
$options = 'i';

$return = mb_ereg_search_regs($pattern, $options);

var_export($return);

array (
  0 => '🐘string',
)

4 · options · x

<?

$string = '🐘string';

mb_ereg_search_init($string);

$pattern = '🐘 s t r i n g';
$options = 'x';

$return = mb_ereg_search_regs($pattern, $options);

var_export($return);

array (
  0 => '🐘string',
)

5 · options · m

<?

$string = '
🐘string';

mb_ereg_search_init($string);

$pattern = '.🐘string';
$options = 'm';

$return = mb_ereg_search_regs($pattern, $options);

var_export($return);

array (
  0 => '
🐘string',
)

6 · options · s

<?

$string = '🐘string';

mb_ereg_search_init($string);

$pattern = '^🐘string$';
$options = 's';

$return = mb_ereg_search_regs($pattern, $options);

var_export($return);

array (
  0 => '🐘string',
)

7 · options · p

<?

$string = '
🐘string';

mb_ereg_search_init($string);

$pattern = '^.🐘string$';
$options = 'p';

$return = mb_ereg_search_regs($pattern, $options);

var_export($return);

array (
  0 => '
🐘string',
)

8 · options · l

<?

$string = '🐘stringtring';

mb_ereg_search_init($string);

$pattern = '🐘.*tring';
$options = 'l';

$return = mb_ereg_search_regs($pattern, $options);

var_export($return);

array (
  0 => '🐘stringtring',
)

9 · options · n

<?

$string = '🐘string';

mb_ereg_search_init($string);

$pattern = '';
$options = 'n';

$return = mb_ereg_search_regs($pattern, $options);

var_export($return);

false