mb_ereg_replace_callback
string$pattern,
callable$callback,
string$string,
[string|null$options = null]
): string|false|null
Scans string for matches to pattern, then replaces the matched text with the output of callback function.
The behavior of this function is almost identical to mb_ereg_replace, except for the fact that instead of replacement parameter, one should specify a callback.
Parameters
- pattern
-
The regular expression pattern.
Multibyte characters may be used in pattern.
- callback
-
A callback that will be called and passed an array of matched elements in the subject string. The callback should return the replacement string.
You'll often need the callback function for a mb_ereg_replace_callback in just one place. In this case you can use an anonymous function to declare the callback within the call to mb_ereg_replace_callback. By doing it this way you have all information for the call in one place and do not clutter the function namespace with a callback function's name not used anywhere else.
- string
-
The string being checked.
- options
-
The search option. See mb_regex_set_options for explanation.
Return Values
The resultant string on success, or false on error. If string is not valid for the current encoding, null is returned.
Notes
Note:
The internal encoding or the character encoding specified by mb_regex_encoding will be used as the character encoding for this function.
Changelog
Version | Description |
8.0.0 | options is nullable now. |
7.1.0 | The function checks whether string is valid for the current encoding. |