summaryrefslogtreecommitdiffstats
path: root/wp-includes/class-wp-block-styles-registry.php
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:56:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:56:49 +0000
commita415c29efee45520ae252d2aa28f1083a521cd7b (patch)
treef4ade4b6668ecc0765de7e1424f7c1427ad433ff /wp-includes/class-wp-block-styles-registry.php
parentInitial commit. (diff)
downloadwordpress-a415c29efee45520ae252d2aa28f1083a521cd7b.tar.xz
wordpress-a415c29efee45520ae252d2aa28f1083a521cd7b.zip
Adding upstream version 6.4.3+dfsg1.upstream/6.4.3+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'wp-includes/class-wp-block-styles-registry.php')
-rw-r--r--wp-includes/class-wp-block-styles-registry.php198
1 files changed, 198 insertions, 0 deletions
diff --git a/wp-includes/class-wp-block-styles-registry.php b/wp-includes/class-wp-block-styles-registry.php
new file mode 100644
index 0000000..317c648
--- /dev/null
+++ b/wp-includes/class-wp-block-styles-registry.php
@@ -0,0 +1,198 @@
+<?php
+/**
+ * Blocks API: WP_Block_Styles_Registry class
+ *
+ * @package WordPress
+ * @subpackage Blocks
+ * @since 5.3.0
+ */
+
+/**
+ * Class used for interacting with block styles.
+ *
+ * @since 5.3.0
+ */
+#[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[]
+ */
+ 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
+ *
+ * @link https://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles/
+ *
+ * @param string $block_name Block type name including namespace.
+ * @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.
+ * }
+ * @return bool True if the block style was registered with success and false otherwise.
+ */
+ public function register( $block_name, $style_properties ) {
+
+ if ( ! isset( $block_name ) || ! is_string( $block_name ) ) {
+ _doing_it_wrong(
+ __METHOD__,
+ __( 'Block name must be a string.' ),
+ '5.3.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'];
+
+ 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;
+ }
+
+ /**
+ * 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 Registered block style properties.
+ */
+ 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[] Array of arrays containing the registered block styles properties grouped by block type.
+ */
+ 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[] Array whose keys are block style names and whose values are block style properties.
+ */
+ public function get_registered_styles_for_block( $block_name ) {
+ if ( isset( $this->registered_block_styles[ $block_name ] ) ) {
+ return $this->registered_block_styles[ $block_name ];
+ }
+ return array();
+ }
+
+ /**
+ * Checks if a block style is registered 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 bool True if the block style is registered, false otherwise.
+ */
+ public function is_registered( $block_name, $block_style_name ) {
+ return isset( $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() {
+ if ( null === self::$instance ) {
+ self::$instance = new self();
+ }
+
+ return self::$instance;
+ }
+}