wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_register_background_support › WordPress Function

Since6.4.0
Deprecatedn/a
› wp_register_background_support ( $block_type )
Access:
  • private
Parameters:
  • (WP_Block_Type) $block_type Block Type.
    Required: Yes
Defined at:
Codex:

Registers the style block attribute for block types that support it.



Related Functions: wp_render_background_support, wp_register_border_support, wp_register_layout_support, wp_register_spacing_support, wp_register_shadow_support

Source 

function wp_register_background_support( $block_type ) {
	// Setup attributes and styles within that if needed.
	if ( ! $block_type->attributes ) {
		$block_type->attributes = array();
	}

	// Check for existing style attribute definition e.g. from block.json.
	if ( array_key_exists( 'style', $block_type->attributes ) ) {
		return;
	}

	$has_background_support = block_has_support( $block_type, array( 'background' ), false );

	if ( $has_background_support ) {
		$block_type->attributes['style'] = array(
			'type' => 'object',
		);
	}
}