php8.5
Home/ Manual/ reference / spl/ The RegexIterator class

The RegexIterator class

This iterator can be used to filter another iterator based on a regular expression.

Intro

This iterator can be used to filter another iterator based on a regular expression.

Class synopsis

class RegexIterator extends FilterIterator { }

Predefined Constants

RegexIterator operation modes

RegexIterator::ALL_MATCHES

Return all matches for the current entry (see preg_match_all()).

RegexIterator::GET_MATCH

Return the first match for the current entry (see preg_match()).

RegexIterator::MATCH

Only execute match (filter) for the current entry (see preg_match()).

RegexIterator::REPLACE

Replace the current entry (see preg_replace(); Not fully implemented yet)

RegexIterator::SPLIT

Returns the split values for the current entry (see preg_split()).

RegexIterator Flags

RegexIterator::USE_KEY

Special flag: Match the entry key instead of the entry value.

RegexIterator::INVERT_MATCH

Inverts the return value of RegexIterator::accept.

Properties

replacement

Changelog

VersionDescription

Regexiterator

In this section

Source: reference/spl/regexiterator.xml · from the official PHP manual (php/doc-en)