wppaste
WordPress

WP_HTML_Processor::get_attribute_names_with_prefix( string $prefix ): array|null

Since
6.6.0
Source
wp-includes/html-api/class-wp-html-processor.php:5385
Gets lowercase names of all attributes matching a given prefix in the current tag.

Description

Note that matching is case-insensitive. This is in accordance with the spec:

There must never be two or more attributes on the same start tag whose names are an ASCII case-insensitive match for each other.

  • HTML 5 spec

Example:

$p = new WP_HTML_Tag_Processor( '<div data-ENABLED class="test" DATA-test-id="14">Test</div>' );
$p->next_tag( array( 'class_name' => 'test' ) ) === true;
$p->get_attribute_names_with_prefix( 'data-' ) === array( 'data-enabled', 'data-test-id' );

$p->next_tag() === false;
$p->get_attribute_names_with_prefix( 'data-' ) === null;

Compatibility

WordPress
since 6.6.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$prefixstring
Prefix of requested attribute names.

Return value

array|null
List of attribute names, or null when no tag opener is matched.

Performance profile

How much work a call to WP_HTML_Processor::get_attribute_names_with_prefix() 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
8–10

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place 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_names_with_prefix() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
->is_virtual()8->is_virtual()
!->is_virtual()10->is_virtual(), ::get_attribute_names_with_prefix()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev118–911 fewer instruction than PHP 8.5
8.5128–101
8.4128–101
8.3128–101
8.2128–101
8.1128–101
7.4128–101

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

Used by · 1

Source code

View on Trac View on GitHub 

	public function get_attribute_names_with_prefix( $prefix ): ?array {		return $this->is_virtual() ? null : parent::get_attribute_names_with_prefix( $prefix );	}

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.