CoreFiles by mySites.guru
class-wp-block-styles-registry.php222 lines, 7,562 bytes, from wordpress-7.2-beta5.zip
Raw History Compare with 7.2-beta4
md5
7b932527cb91bba6df5fb6dd42578ca7
sha1
6029c67b4a17ddf9888f30a0d8eed10a6de44d80
sha256
e551171668d84daba42f7076e913c1a920b23747274218e15272a6a9324b6fdd
<?php
/**
 * Blocks API: WP_Block_Styles_Registry class
 *
 * @package WordPress
 * @subpackage Blocks
 * @since 5.3.0
 */

/**
 * Class used for interacting with block styles.
 *
 * The properties of a block style as the registry stores them are more than its register() hash
 * accepts: `name` is required for a style to be registered at all, and `label` is filled in from
 * the name when the caller omits it, so both are always present on the way back out. The shape
 * stays open because the array is stored verbatim, so a caller's own keys survive, including
 * into the REST response, which does not set `additionalProperties` to false.
 *
 * @since 5.3.0
 *
 * @phpstan-type Block_Style_Properties array{
 *     name: string,
 *     label: string,
 *     inline_style?: string,
 *     style_handle?: string,
 *     is_default?: bool,
 *     style_data?: array<string, mixed>,
 *     ...
 * }
 */
#[AllowDynamicProperties]
final class WP_Block_Styles_Registry {
	/**
	 * Registered block styles, as `$block_name => $block_style_name => $block_style_properties` multidimensional arrays.
	 *
	 * @since 5.3.0
	 *
	 * @var array<string, array<string, array<string, mixed>>>
	 * @phpstan-var array<string, array<string, Block_Style_Properties>>
	 */
	private $registered_block_styles = array();

	/**
	 * Container for the main instance of the class.
	 *
	 * @since 5.3.0
	 *
	 * @var WP_Block_Styles_Registry|null
	 */
	private static $instance = null;

	/**
	 * Registers a block style for the given block type.
	 *
	 * If the block styles are present in a standalone stylesheet, register it and pass
	 * its handle as the `style_handle` argument. If the block styles should be inline,
	 * use the `inline_style` argument. Usually, one of them would be used to pass CSS
	 * styles. However, you could also skip them and provide CSS styles in any stylesheet
	 * or with an inline tag.
	 *
	 * @since 5.3.0
	 * @since 6.6.0 Added ability to register style across multiple block types along with theme.json-like style data.
	 *
	 * @link https://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles/
	 *
	 * @param string|string[] $block_name       Block type name including namespace or array of namespaced block type names.
	 * @param array           $style_properties {
	 *     Array containing the properties of the style.
	 *
	 *     @type string               $name         The identifier of the style used to compute a CSS class.
	 *     @type string               $label        A human-readable label for the style.
	 *     @type string               $inline_style Inline CSS code that registers the CSS class required
	 *                                              for the style.
	 *     @type string               $style_handle The handle to an already registered style that should be
	 *                                              enqueued in places where block styles are needed.
	 *     @type bool                 $is_default   Whether this is the default style for the block type.
	 *     @type array<string, mixed> $style_data   Theme.json-like object to generate CSS from.
	 * }
	 * @return bool True if the block style was registered with success and false otherwise.
	 */
	public function register( $block_name, $style_properties ) {

		if ( ! is_string( $block_name ) && ! is_array( $block_name ) ) {
			_doing_it_wrong(
				__METHOD__,
				__( 'Block name must be a string or array.' ),
				'6.6.0'
			);
			return false;
		}

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

		if ( str_contains( $style_properties['name'], ' ' ) ) {
			_doing_it_wrong(
				__METHOD__,
				__( 'Block style name must not contain any spaces.' ),
				'5.9.0'
			);
			return false;
		}

		$block_style_name = $style_properties['name'];
		$block_names      = is_string( $block_name ) ? array( $block_name ) : $block_name;

		// Ensure there is a label defined.
		if ( empty( $style_properties['label'] ) ) {
			$style_properties['label'] = $block_style_name;
		}

		foreach ( $block_names as $name ) {
			$this->registered_block_styles[ $name ][ $block_style_name ] = $style_properties;
		}

		return true;
	}

	/**
	 * Unregisters a block style of the given block type.
	 *
	 * @since 5.3.0
	 *
	 * @param string $block_name       Block type name including namespace.
	 * @param string $block_style_name Block style name.
	 * @return bool True if the block style was unregistered with success and false otherwise.
	 */
	public function unregister( $block_name, $block_style_name ) {
		if ( ! $this->is_registered( $block_name, $block_style_name ) ) {
			_doing_it_wrong(
				__METHOD__,
				/* translators: 1: Block name, 2: Block style name. */
				sprintf( __( 'Block "%1$s" does not contain a style named "%2$s".' ), $block_name, $block_style_name ),
				'5.3.0'
			);
			return false;
		}

		unset( $this->registered_block_styles[ $block_name ][ $block_style_name ] );

		return true;
	}

	/**
	 * Retrieves the properties of a registered block style for the given block type.
	 *
	 * @since 5.3.0
	 *
	 * @param string $block_name       Block type name including namespace.
	 * @param string $block_style_name Block style name.
	 * @return array<string, mixed>|null Registered block style properties or `null` if the block style is not registered.
	 * @phpstan-return Block_Style_Properties|null
	 */
	public function get_registered( $block_name, $block_style_name ) {
		if ( ! $this->is_registered( $block_name, $block_style_name ) ) {
			return null;
		}

		return $this->registered_block_styles[ $block_name ][ $block_style_name ];
	}

	/**
	 * Retrieves all registered block styles.
	 *
	 * @since 5.3.0
	 *
	 * @return array<string, array<string, array<string, mixed>>> Array of arrays containing the registered block styles
	 *                                                            properties grouped by block type.
	 * @phpstan-return array<string, array<string, Block_Style_Properties>>
	 */
	public function get_all_registered() {
		return $this->registered_block_styles;
	}

	/**
	 * Retrieves registered block styles for a specific block type.
	 *
	 * @since 5.3.0
	 *
	 * @param string $block_name Block type name including namespace.
	 * @return array<string, array<string, mixed>> Array whose keys are block style names and whose values are
	 *                                             block style properties.
	 * @phpstan-return array<string, Block_Style_Properties>
	 */
	public function get_registered_styles_for_block( $block_name ) {
		return $this->registered_block_styles[ $block_name ] ?? array();
	}

	/**
	 * Checks if a block style is registered for the given block type.
	 *
	 * @since 5.3.0
	 *
	 * @param string|null $block_name       Block type name including namespace.
	 * @param string|null $block_style_name Block style name.
	 * @return bool True if the block style is registered, false otherwise.
	 */
	public function is_registered( $block_name, $block_style_name ) {
		return isset( $block_name, $block_style_name, $this->registered_block_styles[ $block_name ][ $block_style_name ] );
	}

	/**
	 * Utility method to retrieve the main instance of the class.
	 *
	 * The instance will be created if it does not exist yet.
	 *
	 * @since 5.3.0
	 *
	 * @return WP_Block_Styles_Registry The main instance.
	 */
	public static function get_instance() {
		self::$instance ??= new self();

		return self::$instance;
	}
}

The same content is in 3 releases, WordPress 7.2-beta5 to 7.2-RC2. See them all, or every version of this file.