array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.mb-regex-set-options.php', 1 => 'mb_regex_set_options', 2 => 'Set/Get the default options for mbregex functions', ), 'up' => array ( 0 => 'ref.mbstring.php', 1 => 'Multibyte String Functions', ), 'prev' => array ( 0 => 'function.mb-regex-encoding.php', 1 => 'mb_regex_encoding', ), 'next' => array ( 0 => 'function.mb-rtrim.php', 1 => 'mb_rtrim', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/mbstring/functions/mb-regex-set-options.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

mb_regex_set_options

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

mb_regex_set_options — Set/Get the default options for mbregex functions

Description

mb_regex_set_options(?string $options = null): string

Sets the default options described by options for multibyte regex functions.

Parameters

options

The options to set. This is a string where each character is an option. To set a mode, the mode character must be the last one set, however there can only be set one mode but multiple options.

Regex options
Option Meaning Changelog
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  
e eval() resulting code Deprecated as of PHP 7.1.0 and removed as of PHP 8.0.0

Note:

The "e" option has no effect when set through mb_regex_set_options(). Use it with mb_ereg_replace() or mb_eregi_replace().

Regex syntax modes (only one may be set)
Mode Meaning
j Java (Sun java.util.regex)
u GNU regex
g grep
c Emacs
r Ruby
z Perl
b POSIX Basic regex
d POSIX Extended regex

Return Values

The previous options. If options is omitted or null, it returns the string that describes the current options.

Changelog

Version Description
8.0.0 If the parameter options is given and not null, the previous options are returned. Formerly, the current options have been returned.
8.0.0 options is nullable now.
8.0.0 The "e" option now throws a ValueError.
7.1.0 The "e" option now emits an E_DEPRECATED.

See Also