get_block_editor_server_block_settings() – Function

Prepares server-registered blocks for the block editor.

Description

Returns an associative array of registered block data keyed by block name. Data includes properties of a block relevant for client registration.

Return

array An associative array of registered block data.

Source

 * Prepares server-registered blocks for the block editor.
 *
 * Returns an associative array of registered block data keyed by block name. Data includes properties
 * of a block relevant for client registration.
 *
 * @since 5.0.0
 * @since 6.3.0 Added `selectors` field.
 * @since 6.4.0 Added `block_hooks` field.
 *
 * @return array An associative array of registered block data.
 */
function get_block_editor_server_block_settings() {
	$block_registry = WP_Block_Type_Registry::get_instance();
	$blocks         = array();
	$fields_to_pick = array(
		'api_version'      => 'apiVersion',
		'title'            => 'title',
		'description'      => 'description',
		'icon'             => 'icon',
		'attributes'       => 'attributes',
		'provides_context' => 'providesContext',
		'uses_context'     => 'usesContext',
		'block_hooks'      => 'blockHooks',
		'selectors'        => 'selectors',
		'supports'         => 'supports',
		'category'         => 'category',
		'styles'           => 'styles',
		'textdomain'       => 'textdomain',
		'parent'           => 'parent',
		'ancestor'         => 'ancestor',
		'keywords'         => 'keywords',
		'example'          => 'example',
		'variations'       => 'variations',
		'allowed_blocks'   => 'allowedBlocks',
	);

	foreach ( $block_registry->get_all_registered() as $block_name => $block_type ) {
		foreach ( $fields_to_pick as $field => $key ) {
			if ( ! isset( $block_type->{ $field } ) ) {
				continue;
			}

View all references View on Trac View on GitHub

Changelog

Version	Description
6.4.0	Added `block_hooks` field.
6.3.0	Added `selectors` field.
5.0.0	Introduced.

User Contributed Notes

Darshit Rajyaguru 2 years ago

// Define a callback function to register block settings
function wpdocs_register_block_settings() {
    $block_type = 'core/paragraph'; // Replace with the block type you want to customize

    $settings = get_block_editor_server_block_settings( $block_type );

    // Modify the block settings as needed
    $settings['attributes']['customAttribute'] = array(
        'type'    => 'string',
        'default' => 'Custom Default Value',
    );

    // Re-register the block with the modified settings
    register_block_type( $block_type, $settings );
}

// Hook the callback function into the 'init' action
add_action( 'init', 'wpdocs_register_block_settings' );

get_block_editor_server_block_settings(): array

In this article

Description

Return

Source

Changelog

User Contributed Notes