get_allowed_block_types() WordPress Function
The get_allowed_block_types() function is used to retrieve the list of blocks that are allowed to be used on the current post. This function is useful for restricting the blocks that can be used on a post to only those that are allowed by the current user.
get_allowed_block_types( WP_Block_Editor_Context $block_editor_context ) #
Gets the list of allowed block types to use in the block editor.
Parameters
- $block_editor_context
(WP_Block_Editor_Context)(Required)The current block editor context.
Return
(bool|string[]) Array of block type slugs, or boolean to enable/disable all.
Source
File: wp-includes/block-editor.php
function get_allowed_block_types( $block_editor_context ) { $allowed_block_types = true; /** * Filters the allowed block types for all editor types. * * @since 5.8.0 * * @param bool|string[] $allowed_block_types Array of block type slugs, or boolean to enable/disable all. * Default true (all registered block types supported). * @param WP_Block_Editor_Context $block_editor_context The current block editor context. */ $allowed_block_types = apply_filters( 'allowed_block_types_all', $allowed_block_types, $block_editor_context ); if ( ! empty( $block_editor_context->post ) ) { $post = $block_editor_context->post; /** * Filters the allowed block types for the editor. * * @since 5.0.0 * @deprecated 5.8.0 Use the {@see 'allowed_block_types_all'} filter instead. * * @param bool|string[] $allowed_block_types Array of block type slugs, or boolean to enable/disable all. * Default true (all registered block types supported) * @param WP_Post $post The post resource data. */ $allowed_block_types = apply_filters_deprecated( 'allowed_block_types', array( $allowed_block_types, $post ), '5.8.0', 'allowed_block_types_all' ); } return $allowed_block_types; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.8.0 | Introduced. |