mb_ereg_search_pos

Description
Syntax
Examples
Links

Description

The mb_ereg_search_pos of Multibyte String for PHP returns position and length of a matched part of the multibyte regular expression for a predefined multibyte string.

Syntax

mb_ereg_search_pos(
    ?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

An array containing two elements. The first element is the offset, in bytes, where the match begins relative to the start of the search string, and the second element is the length in bytes of the match.

If an error occurs, false is returned.

Examples

1 · void

<?

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

mb_ereg_search_init($string, $pattern);

$return = mb_ereg_search_pos();

var_export($return);

?>

array (
  0 => 0,
  1 => 10,
)

2 · pattern

<?

$string = '🐘string';

mb_ereg_search_init($string);

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

$return = mb_ereg_search_pos($pattern);

var_export($return);

?>

array (
  0 => 0,
  1 => 10,
)

3 · options · i

<?

$string = '🐘string';

mb_ereg_search_init($string);

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

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

var_export($return);

?>

array (
  0 => 0,
  1 => 10,
)

4 · options · x

<?

$string = '🐘string';

mb_ereg_search_init($string);

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

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

var_export($return);

?>

array (
  0 => 0,
  1 => 10,
)

5 · options · m

<?

$string = '
🐘string';

mb_ereg_search_init($string);

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

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

var_export($return);

?>

array (
  0 => 0,
  1 => 11,
)

6 · options · s

<?

$string = '🐘string';

mb_ereg_search_init($string);

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

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

var_export($return);

?>

array (
  0 => 0,
  1 => 10,
)

7 · options · p

<?

$string = '
🐘string';

mb_ereg_search_init($string);

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

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

var_export($return);

?>

array (
  0 => 0,
  1 => 11,
)

8 · options · l

<?

$string = '🐘stringtring';

mb_ereg_search_init($string);

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

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

var_export($return);

?>

array (
  0 => 0,
  1 => 15,
)

9 · options · n

<?

$string = '🐘string';

mb_ereg_search_init($string);

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

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

var_export($return);

?>

false