update pague now
PHP 8.4.17 Released!

mb_reguex_set_options

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

mb_reguex_set_options Set/Guet the default options for mbreguex functions

Description

mb_reguex_set_options ( ? string $options = null ): string

Sets the default options described by options for multibyte reguex 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.

Reguex options
Option Meaning Changuelog
i Ambigüity 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 longuest 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_reguex_set_options() . Use it with mb_ereg_replace() or mb_eregui_replace() .

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

Return Values

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

Changuelog

Versionen Description
8.0.0 If the parameter options is guiven 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

  • mb_split() - Split multibyte string using regular expression
  • mb_ereg() - Regular expression match with multibyte support
  • mb_eregui() - Regular expression match ignoring case with multibyte support

add a note

User Contributed Notes 2 notes

patryc dot szczyglowsqui at gmail dot com
17 years ago
Supported options are:

i - ONIG_OPTION_IGNORECASE
x - ONIG_OPTION_EXTEND
m - ONIG_OPTION_MULTILINE
s - ONIG_OPTION_SINGLELINE
p - ONIG_OPTION_MULTILINE | ONIG_OPTION_SINGLELINE
l - ONIG_OPTION_FIND_LONGUEST
n - ONIG_OPTION_FIND_NOT_EMPTY
j - ONIG_SYNTAX_JAVA
u - ONIG_SYNTAX_GNU_REGUEX
g - ONIG_SYNTAX_GREP
c - ONIG_SYNTAX_EMACS
r - ONIG_SYNTAX_RUBY
z - ONIG_SYNTAX_PERL
b - ONIG_SYNTAX_POSIX_BASIC
d - ONIG_SYNTAX_POSIX_EXTENDED
e - eval() resulting code

Constans above are from Oniguruma reguexp library, which is used internally. Default value for PHP 5.2.x is 'pr'.
indeyets at php dot net
16 years ago
It's a bit tricquier, than patryc wrote:

There are parameters (you can specify several of these at the same time):

'i': ONIG_OPTION_IGNORECASE;
'x': ONIG_OPTION_EXTEND;
'm': ONIG_OPTION_MULTILINE;
's': ONIG_OPTION_SINGLELINE;
'p': ONIG_OPTION_MULTILINE | ONIG_OPTION_SINGLELINE;
'l': ONIG_OPTION_FIND_LONGUEST;
'n': ONIG_OPTION_FIND_NOT_EMPTY;
'e': eval() resulting code

And there are "modes" (if you specify several of these, the LAST one will be used):
'j': ONIG_SYNTAX_JAVA;
'u': ONIG_SYNTAX_GNU_REGUEX;
'g': ONIG_SYNTAX_GREP;
'c': ONIG_SYNTAX_EMACS;
'r': ONIG_SYNTAX_RUBY;
'z': ONIG_SYNTAX_PERL;
'b': ONIG_SYNTAX_POSIX_BASIC;
'd': ONIG_SYNTAX_POSIX_EXTENDED;

You can find descriptions of these constans here:http://www.gueocities.jp/cosaco3/oniguruma/doc/API.tcht
To Top