filter_block_content( string $text, array[]|string $allowed_html = 'post', string[] $allowed_protocols = array() ): 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

$textstring

Text that may contain block content.

$allowed_htmlarray[]|stringoptional

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. Default 'post'.Default: 'post'

$allowed_protocolsstring[]optional

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

Return value

string

The filtered and sanitized content result.

Performance profile

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

13–22

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

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

• regexregular expression over the whole inputpreg_replace_callback()called directly
• hookthird-party callbacksapply_filters()one call below filter_block_content()

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

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

Uses · 4

• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• parse_blocks()Parses blocks out of a content string.
• filter_block_kses()Filters and sanitizes a parsed block to remove non-allowable HTML from block attribute values.
• serialize_block()Returns the content of a block, including comment delimiters, serializing all attributes from the given parsed block.

Used by · 1

• wp_pre_kses_block_attributes()Removes non-allowable HTML from parsed block attribute values when filtering in the post context.

Source code

View on Trac ↗View on GitHub ↗

2121function filter_block_content( $text, $allowed_html = 'post', $allowed_protocols = array() ) {2122	$result = '';2123 2124	if ( str_contains( $text, '<!--' ) && str_contains( $text, '--->' ) ) {2125		$text = preg_replace_callback( '%<!--(.*?)--->%', '_filter_block_content_callback', $text );2126	}2127 2128	$blocks = parse_blocks( $text );2129	foreach ( $blocks as $block ) {2130		$block   = filter_block_kses( $block, $allowed_html, $allowed_protocols );2131		$result .= serialize_block( $block );2132	}2133 2134	return $result;2135}

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.