wppaste
WordPress

WP_HTML_Processor::set_attribute( string $name, string|bool $value ): bool

Since
6.6.0, 6.9.0
Source
wp-includes/html-api/class-wp-html-processor.php:5343
Updates or creates a new attribute on the currently matched tag with the passed value.

Description

This function handles all necessary HTML encoding. Provide normal, unescaped string values.
The HTML API will encode the strings appropriately so that the browser will interpret them as the intended value.

Example:

// Renders “Eggs & Milk” in a browser, encoded as <abbr title="Eggs &amp; Milk">.
$processor->set_attribute( 'title', 'Eggs & Milk' );

// Renders “Eggs &amp; Milk” in a browser, encoded as <abbr title="Eggs &amp;amp; Milk">.
$processor->set_attribute( 'title', 'Eggs &amp; Milk' );

// Renders true as <abbr title>.
$processor->set_attribute( 'title', true );

// Renders without the attribute for false as <abbr>.
$processor->set_attribute( 'title', false );

Special handling is provided for boolean attribute values:

  • When true is passed as the value, then only the attribute name is added to the tag.
  • When false is passed, the attribute gets removed if it existed before.

Compatibility

WordPress
since 6.9.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

$namestring
The attribute name to target.
$valuestring|bool
The new attribute value.

Return value

bool
Whether an attribute value was set.

Performance profile

How much work a call to WP_HTML_Processor::set_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
9–12

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

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

WhenInstructionsCalls it makes
->is_virtual()9->is_virtual()
!->is_virtual()12->is_virtual(), ::set_attribute()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev139–1111 fewer instruction than PHP 8.5
8.5149–121
8.4149–121
8.3149–121
8.2149–121
8.1149–121
7.4149–121

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

Source code

View on Trac View on GitHub 

	public function set_attribute( $name, $value ): bool {		return $this->is_virtual() ? false : parent::set_attribute( $name, $value );	}

Changelog

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

6.9.0
Escapes all character references instead of trying to avoid double-escaping.from the docblock
6.6.0
Subclassed for the HTML Processor.from the docblock

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.