wppaste
WordPress

filter_block_core_template_part_attributes( string $attribute_value, string $attribute_name, array[]|string $allowed_html ): string

Since
6.5.5
Source
wp-includes/blocks.php:2226
Sanitizes the value of the Template Part block's tagName attribute.

Compatibility

WordPress
since 6.5.5
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

$attribute_valuestring
The attribute value to filter.
$attribute_namestring
The attribute name.
$allowed_htmlarray[]|string
An array of allowed HTML elements and attributes, or a context name such as 'post'. See wp_kses_allowed_html() for the list of accepted context names.

Return value

string
The sanitized attribute value.

Performance profile

How much work a call to filter_block_core_template_part_attributes() 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
6–16

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

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 it touches

  • hookthird-party callbacksapply_filters()one call below filter_block_core_template_part_attributes()

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

WhenInstructionsCalls it makes
always6–12none
!empty($attribute_value) && $attribute_name === "tagName" && !is_array($allowed_html)16wp_kses_allowed_html()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 18 instructions, 6–16 executed per call, 4 branches. The work does not change between versions.

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 · 1

Used by · 1

Source code

function filter_block_core_template_part_attributes( $attribute_value, $attribute_name, $allowed_html ) {	if ( empty( $attribute_value ) || 'tagName' !== $attribute_name ) {		return $attribute_value;	}	if ( ! is_array( $allowed_html ) ) {		$allowed_html = wp_kses_allowed_html( $allowed_html );	}	return isset( $allowed_html[ $attribute_value ] ) ? $attribute_value : '';}

Changelog

Introduced in 6.5.5. 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/blocks.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.