filter_block_kses_value( string[]|string $value, array[]|string $allowed_html, string[] $allowed_protocols = array(), array $block_context = null ): string[]|string

Compatibility

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

Parameters

$valuestring[]|string

The attribute value to filter.

$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.

$allowed_protocolsstring[]optional

Array of allowed URL protocols.
Defaults to the result of wp_allowed_protocols().Default: array()

$block_contextarrayoptional

The block the attribute belongs to, in parsed block array format.Default: null

Return value

string[]|string

The filtered and sanitized result.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

9–14

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

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

Uses · 3

• filter_block_kses_value()Filters and sanitizes a parsed block attribute value to remove non-allowable HTML.
• filter_block_core_template_part_attributes()Sanitizes the value of the Template Part block's `tagName` attribute.
• wp_kses()Filters text content and strips out disallowed HTML.

Used by · 2

• filter_block_kses()Filters and sanitizes a parsed block to remove non-allowable HTML from block attribute values.
• filter_block_kses_value()Filters and sanitizes a parsed block attribute value to remove non-allowable HTML.

Source code

View on Trac ↗View on GitHub ↗

2192function filter_block_kses_value( $value, $allowed_html, $allowed_protocols = array(), $block_context = null ) {2193	if ( is_array( $value ) ) {2194		foreach ( $value as $key => $inner_value ) {2195			$filtered_key   = filter_block_kses_value( $key, $allowed_html, $allowed_protocols, $block_context );2196			$filtered_value = filter_block_kses_value( $inner_value, $allowed_html, $allowed_protocols, $block_context );2197 2198			if ( isset( $block_context['blockName'] ) && 'core/template-part' === $block_context['blockName'] ) {2199				$filtered_value = filter_block_core_template_part_attributes( $filtered_value, $filtered_key, $allowed_html );2200			}2201			if ( $filtered_key !== $key ) {2202				unset( $value[ $key ] );2203			}2204 2205			$value[ $filtered_key ] = $filtered_value;2206		}2207	} elseif ( is_string( $value ) ) {2208		return wp_kses( $value, $allowed_html, $allowed_protocols );2209	}2210 2211	return $value;2212}

Changelog

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