WP_HTML_Processor::matches_breadcrumbs() │ public │ WP 6.4.0

Indicates if the currently-matched tag matches the given breadcrumbs.

A "*" represents a single tag wildcard, where any tag matches, but not no tags.

At some point this function _may_ support a ** syntax for matching any number of unspecified tags in the breadcrumb stack. This has been intentionally left out, however, to keep this function simple and to avoid introducing backtracking, which could open up surprising performance breakdowns.

Example:

$processor = WP_HTML_Processor::create_fragment( '<div><span><figure><img></figure></span></div>' );
$processor->next_tag( 'img' );
true  === $processor->matches_breadcrumbs( array( 'figure', 'img' ) );
true  === $processor->matches_breadcrumbs( array( 'span', 'figure', 'img' ) );
false === $processor->matches_breadcrumbs( array( 'span', 'img' ) );
true  === $processor->matches_breadcrumbs( array( 'span', '*', 'img' ) );

Method of the class: WP_HTML_Processor{}

No Hooks.

Return

true|false. Whether the currently-matched tag is found at the given nested structure.

Usage

$WP_HTML_Processor = new WP_HTML_Processor();
$WP_HTML_Processor->matches_breadcrumbs( $breadcrumbs );

$breadcrumbs(string[]) (required)

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','*').

Changelog

WP_HTML_Processor::matches_breadcrumbs() WP HTML Processor::matches breadcrumbs code ^{WP 6.6.2}

public function matches_breadcrumbs( $breadcrumbs ) {
	// Everything matches when there are zero constraints.
	if ( 0 === count( $breadcrumbs ) ) {
		return true;
	}

	// Start at the last crumb.
	$crumb = end( $breadcrumbs );

	if ( '*' !== $crumb && $this->get_tag() !== strtoupper( $crumb ) ) {
		return false;
	}

	foreach ( $this->state->stack_of_open_elements->walk_up() as $node ) {
		$crumb = strtoupper( current( $breadcrumbs ) );

		if ( '*' !== $crumb && $node->node_name !== $crumb ) {
			return false;
		}

		if ( false === prev( $breadcrumbs ) ) {
			return true;
		}
	}

	return false;
}