get_allowed_block_types( WP_Block_Editor_Context $block_editor_context ): bool|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

$block_editor_contextWP_Block_Editor_Context

The current block editor context.

Return value

bool|string[]

Array of block type slugs, or boolean to enable/disable all.

Performance profile

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

11–21

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

Plugin surface

2 hooks

Third-party callbacks on 'allowed_block_types_all', 'allowed_block_types' run inside this call, and their cost is not bounded by anything here.

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()called directly

Further down the call graph this can also reach query, option, cache, serialize 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 · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_allowed_block_types() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while get_allowed_block_types() runs, in this order:

1. 1
   apply_filters( allowed_block_types_all )filterline 127 (+12 into the body)

   Filters the allowed block types for all editor types.

2. 2
   do_action( allowed_block_types )filter_deprecatedline 142 (+27 into the body)

   Filters the allowed block types for the editor.

Uses · 2

• apply_filters()Calls the callback functions that have been added to a filter hook.
• apply_filters_deprecated()Fires functions attached to a deprecated filter hook.

Used by · 1

• get_block_editor_settings()Returns the contextualized block editor settings for a selected editor context.

Source code

View on Trac ↗View on GitHub ↗

115function get_allowed_block_types( $block_editor_context ) {116	$allowed_block_types = true;117 118	/**119	 * Filters the allowed block types for all editor types.120	 *121	 * @since 5.8.0122	 *123	 * @param bool|string[]           $allowed_block_types  Array of block type slugs, or boolean to enable/disable all.124	 *                                                      Default true (all registered block types supported).125	 * @param WP_Block_Editor_Context $block_editor_context The current block editor context.126	 */127	$allowed_block_types = apply_filters( 'allowed_block_types_all', $allowed_block_types, $block_editor_context );128 129	if ( ! empty( $block_editor_context->post ) ) {130		$post = $block_editor_context->post;131 132		/**133		 * Filters the allowed block types for the editor.134		 *135		 * @since 5.0.0136		 * @deprecated 5.8.0 Use the {@see 'allowed_block_types_all'} filter instead.137		 *138		 * @param bool|string[] $allowed_block_types Array of block type slugs, or boolean to enable/disable all.139		 *                                           Default true (all registered block types supported)140		 * @param WP_Post       $post                The post resource data.141		 */142		$allowed_block_types = apply_filters_deprecated( 'allowed_block_types', array( $allowed_block_types, $post ), '5.8.0', 'allowed_block_types_all' );143	}144 145	return $allowed_block_types;146}

Changelog

Introduced in 5.8.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/block-editor.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.