WP_HTML_Processor::get_attribute( string $name ): string|true|null

Description

$p = WP_HTML_Processor::create_fragment( '<div enabled class="test" data-test-id="14">Test</div>' );
$p->next_token() === true;
$p->get_attribute( 'data-test-id' ) === '14';
$p->get_attribute( 'enabled' ) === true;
$p->get_attribute( 'aria-label' ) === null;

$p->next_tag() === false;
$p->get_attribute( 'class' ) === null;

Compatibility

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

Parameters

$namestring

Name of attribute whose value is requested.

Return value

string|true|null

Value of attribute or null if not available. Boolean attributes return true.

Performance profile

How much work a call to WP_HTML_Processor::get_attribute() 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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

5–8

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

6

6 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 2 distinct outcomes

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

Uses · 2

• WP_HTML_Processor::is_virtual()Indicates if the currently-matched token is virtual, created by a stack operation while processing HTML, rather than a token found in the HTML text itself.
• WP_HTML_Tag_Processor::get_attribute()Returns the value of a requested attribute from a matched tag opener if that attribute exists.

Used by · 6

• WP_HTML_Processor::is_html_integration_point()Indicates if the current token is an HTML integration point.
• WP_HTML_Processor::serialize_token()Serializes the currently-matched token.
• WP_HTML_Processor::step_in_body()Parses next element in the 'in body' insertion mode.
• WP_HTML_Processor::step_in_foreign_content()Parses next element in the 'in foreign content' insertion mode.
• WP_HTML_Processor::step_in_head()Parses next element in the 'in head' insertion mode.
• WP_HTML_Processor::step_in_table()Parses next element in the 'in table' insertion mode.

Source code

View on Trac ↗View on GitHub ↗

5307	public function get_attribute( $name ) {5308		return $this->is_virtual() ? null : parent::get_attribute( $name );5309	}

Changelog

Introduced in 6.6.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.