WP_Block_Styles_Registry::register

Advertisement

Summery Summery

Registers a block style.

Syntax Syntax

WP_Block_Styles_Registry::register( string $block_name, array $style_properties )

Parameters Parameters

$block_name

(string) (Required) Block type name including namespace.

$style_properties

(array) (Required) Array containing the properties of the style name, label, style (name of the stylesheet to be enqueued), inline_style (string containing the CSS to be added).

Return Return

(boolean) True if the block style was registered with success and false otherwise.

Source Source

File: wp-includes/class-wp-block-styles-registry.php

	public function register( $block_name, $style_properties ) {

		if ( ! isset( $block_name ) || ! is_string( $block_name ) ) {
			$message = __( 'Block name must be a string.' );
			_doing_it_wrong( __METHOD__, $message, '5.3.0' );
			return false;
		}

		if ( ! isset( $style_properties['name'] ) || ! is_string( $style_properties['name'] ) ) {
			$message = __( 'Block style name must be a string.' );
			_doing_it_wrong( __METHOD__, $message, '5.3.0' );
			return false;
		}

		$block_style_name = $style_properties['name'];

		if ( ! isset( $this->registered_block_styles[ $block_name ] ) ) {
			$this->registered_block_styles[ $block_name ] = array();
		}
		$this->registered_block_styles[ $block_name ][ $block_style_name ] = $style_properties;

		return true;
	}

Advertisement

Changelog Changelog

Changelog
Version Description
5.3.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.