mb_ereg_search_init()
mb_ereg_search_init() — Setup string and regular expression for a multibyte regular expression match.
Built-in function of PHP 8.5. The manual lists it as available in PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.
What it does
mb_ereg_search_init() sets string and pattern for a multibyte regular expression. These values are used for mb_ereg_search(), mb_ereg_search_pos(), and mb_ereg_search_regs().
Signature
mb_ereg_search_init(string $string, ?string $pattern = null, ?string $options = null): bool
Parameters
| Parameter | Type | What it takes |
|---|---|---|
| $string | string | The search string. |
| $pattern | ?string | The search pattern. |
| $options | ?string | The search option. See mb_regex_set_options() for explanation. |
Return value
Returns true on success or false on failure.
Example
The PHP manual ships no example for mb_ereg_search_init(); the signature and the parameter table above are the contract.
Changelog
| Version | Change |
|---|---|
| 8.0.0 | pattern and options are nullable now. |
See also
mb_regex_encoding(), mb_ereg_search_regs()
All PHP 8.5 built-in functions
Reference card built from the PHP manual page mb_ereg_search_init() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.