PHP 8.1.0 Beta 1 available for testing


(PHP 5 >= 5.2.0, PHP 7, PHP 8)

RegexIterator::getFlagsGet flags


public RegexIterator::getFlags(): int

Returns the flags, see RegexIterator::setFlags() for a list of available flags.


This function has no parameters.

Return Values

Returns the set flags.


Example #1 RegexIterator::getFlags() example


= array ('str1' => 'test 1''teststr2' => 'another test''str3' => 'test 123');

$arrayIterator = new ArrayIterator($test);
$regexIterator = new RegexIterator($arrayIterator'/^test/');

if (
$regexIterator->getFlags() & RegexIterator::USE_KEY) {
'Filtering based on the array keys.';
} else {
'Filtering based on the array values.';

The above example will output:

Filtering based on the array keys.

See Also

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top