mb_ereg
(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)
mb_ereg — Regular expression match with multibyte support
Description
$pattern, string $string, array &$matches = null): boolExecutes the regular expression match with multibyte support.
Parameters
-
pattern -
The search pattern.
-
string -
The search string.
-
matches -
If matches are found for parenthesized substrings of
patternand the function is called with the third argumentmatches, the matches will be stored in the elements of the arraymatches. If no matches are found,matchesis set to an empty array.$matches[1] will contain the substring which starts at the first left parenthesis; $matches[2] will contain the substring starting at the second, and so on. $matches[0] will contain a copy of the complete string matched.
Return Values
Returns whether pattern matches string.
Changelog
| Version | Description |
|---|---|
| 8.0.0 |
This function returns true on success now. Previously, it returned the byte length
of the matched string if a match for pattern was found in
string and matches was passed.
If the optional parameter matches was not passed or
the length of the matched string was 0, this function returned 1.
|
| 7.1.0 |
mb_ereg() will now set matches to
an empty array, if nothing matched. Formerly,
matches was not modified in that case.
|
Notes
Note:
The internal encoding or the character encoding specified by mb_regex_encoding() will be used as the character encoding for this function.
See Also
- mb_regex_encoding() - Set/Get character encoding for multibyte regex
- mb_eregi() - Regular expression match ignoring case with multibyte support
