WP_HTML_Processor::next_tag( array|string|null $query = null ): bool

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$queryarray|string|nulloptional

Which tag name to find, having which class, etc. Default is to find any tag.Default: null

• $tag_namestring|null

  Which tag to find, or null for "any tag." @type string $tag_closers 'visit' to pause at tag closers, 'skip' or unset to only visit openers.

• $match_offsetint|null

  Find the Nth tag matching all search criteria. 1 for "first" tag, 3 for "third," etc. Defaults to first tag.

• $class_namestring|null

  Tag must contain this whole class name to match.

• $breadcrumbsstring[]

  DOM sub-path at which element is found, e.g. array( 'FIGURE', 'IMG' ). May also contain the wildcard * which matches a single element, e.g. array( 'SECTION', '*' ).

Return value

bool

Whether a tag was matched.

Performance profile

How much work a call to WP_HTML_Processor::next_tag() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

11–70

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 123.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()one call below WP_HTML_Processor::next_tag()

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 17 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_HTML_Processor::next_tag() can have, taken from its control-flow graph on PHP 8.5.

Uses · 8

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• WP_HTML_Processor::next_token()Finds the next token in the HTML document.
• WP_HTML_Processor::get_token_type()Indicates the kind of matched token, if any.
• WP_HTML_Processor::is_tag_closer()Indicates if the current tag token is a tag closer.
• WP_HTML_Processor::get_token_name()Returns the node name represented by the token.
• WP_HTML_Processor::has_class()Returns if a matched tag contains the given ASCII case-insensitive class name.
• WP_HTML_Processor::matches_breadcrumbs()Indicates if the currently-matched tag matches the given breadcrumbs.

Source code

View on Trac ↗View on GitHub ↗

690	public function next_tag( $query = null ): bool {691		$visit_closers = isset( $query['tag_closers'] ) && 'visit' === $query['tag_closers'];692 693		if ( null === $query ) {694			while ( $this->next_token() ) {695				if ( '#tag' !== $this->get_token_type() ) {696					continue;697				}698 699				if ( ! $this->is_tag_closer() || $visit_closers ) {700					return true;701				}702			}703 704			return false;705		}706 707		if ( is_string( $query ) ) {708			$query = array( 'breadcrumbs' => array( $query ) );709		}710 711		if ( ! is_array( $query ) ) {712			_doing_it_wrong(713				__METHOD__,714				__( 'Please pass a query array to this function.' ),715				'6.4.0'716			);717			return false;718		}719 720		if ( isset( $query['tag_name'] ) ) {721			$query['tag_name'] = strtoupper( $query['tag_name'] );722		}723 724		$needs_class = ( isset( $query['class_name'] ) && is_string( $query['class_name'] ) )725			? $query['class_name']726			: null;727 728		if ( ! ( array_key_exists( 'breadcrumbs', $query ) && is_array( $query['breadcrumbs'] ) ) ) {729			while ( $this->next_token() ) {730				if ( '#tag' !== $this->get_token_type() ) {731					continue;732				}733 734				if ( isset( $query['tag_name'] ) && $query['tag_name'] !== $this->get_token_name() ) {735					continue;736				}737 738				if ( isset( $needs_class ) && ! $this->has_class( $needs_class ) ) {739					continue;740				}741 742				if ( ! $this->is_tag_closer() || $visit_closers ) {743					return true;744				}745			}746 747			return false;748		}749 750		$breadcrumbs  = $query['breadcrumbs'];751		$match_offset = isset( $query['match_offset'] ) ? (int) $query['match_offset'] : 1;752 753		while ( $match_offset > 0 && $this->next_token() ) {754			if ( '#tag' !== $this->get_token_type() || $this->is_tag_closer() ) {755				continue;756			}757 758			if ( isset( $needs_class ) && ! $this->has_class( $needs_class ) ) {759				continue;760			}761 762			if ( $this->matches_breadcrumbs( $breadcrumbs ) && 0 === --$match_offset ) {763				return true;764			}765		}766 767		return false;768	}

Changelog

Introduced in 6.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/html-api/class-wp-html-processor.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.